Skip to content

Commit

Permalink
documentation : modification de la structure de la documentation angl… (
Browse files Browse the repository at this point in the history
#1081)

* documentation : modification de la structure de la documentation anglaise

les changements apportés dans la partie FR ont été reproduit dans la partie EN. On a également corrigé quelques coquilles.
La partie EN est maintenant composée de 4 sous-sections : Features, User Guides, FAQ et Tutorials

* documentation: ajout de quelques mots dans les index de chacune des sections en
  • Loading branch information
RochDLY authored Nov 5, 2024
1 parent f71a188 commit 8424b72
Show file tree
Hide file tree
Showing 35 changed files with 261 additions and 114 deletions.
70 changes: 70 additions & 0 deletions docs/src/en/colophon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: "Colophon"
---

## The project

More than a tool, Stylo is a philosophy of text.
It's based on the idea that we need to design textual models adapted for writing in the humanities and social sciences (SHS).

It is designed and created to write scientific texts, and in particular adapted for SHS journals.

It is currently a prototype tool under development, implemented in the editorial chain of several journals as part of the [Revue 2.0] partnership project (http://revue20.org/).
The tool is also used by various authors and students for their own scientific or institutional work.

Stylo can be used online through the address [stylo.huma-num.fr](https://stylo.huma-num.fr/). This version of Stylo is deployed and maintained by [Huma-Num](https://www.huma-num.fr/), who provides data backup and security.

## *Stylo*-sophy

Stylo, a WYSIWYM text editor for the humanities, is designed to change the entire digital editorial chain of scholarly journals in the humanities and social sciences.

Despite being essential for digital dissemination, structuring documents and their markup are steps usually postponed until the end of the editorial chain, when in reality they should be considered from the beginning of the process (by the author and from the first revision of articles). In this sense, it seems urgent and consistent to reintegrate the markup work and text structuring from the beginning of the editorial chain.

Stylo's philosophy is based around putting the management of markup in the hands of researchers by addressing their competencies; researchers possess more semantically oriented skills, rather than graphic knowledge.

Editing is based on the separation between semantic markup and graphic display, which allows the author to focus on the meaning of the text rather than its formatting.

Stylo offers a free solution that is based on standards (markdown, yaml, BibTex) allowing for:

- Production of well-marked text with rich metadata and a structured bibliography
- Production of multiple outputs (PDF, HTML, XML, ODT...) from just one document

Stylo is a tool that implements formats and existing conversion technologies. These technologies are already used in the community, which enables free circulation of documents that are not enclosed in a particular format.

## Current Contributors

### Researchers

- [Antoine Fauchié](https://ecrituresnumeriques.ca/fr/Equipe/Antoine-Fauchie/)
- [Margot Mellet](https://ecrituresnumeriques.ca/fr/Equipe/Margot-Mellet)
- [Servanne Monjour](https://ecrituresnumeriques.ca/fr/Equipe/Servanne-Monjour-)
- [Nicolas Sauret](https://ecrituresnumeriques.ca/fr/Equipe/Nicolas-Sauret)
- [Marcello Vitali-Rosati](https://ecrituresnumeriques.ca/fr/Equipe/Marcello-Vitali-Rosati-)
- [Roch Delannay](https://ecrituresnumeriques.ca/en/Equipe/Roch-Delannay)
- [Louis-Olivier Brassard](https://www.loupbrun.ca)

### Developers

- [Guillaume Grossetie](https://github.com/ggrossetie)
- [David Larlet](http://larlet.com/)
- [Yves Marcoux](https://recherche.umontreal.ca/fr/nos-equipes-de-recherche/repertoire-des-professeurs/chercheur/is/in14146/)
- [Thomas Parisot](https://détour.studio)

### Designers

- [Maïtané Lenoir](https://maiwann.net/)

### Partners

- [Érudit](http://erudit.org/)
- [Huma-Num](https://www.huma-num.fr/)
- [Métopes](http://www.metopes.fr/)

## Past contributors

- [Arthur Juchereau](https://ecrituresnumeriques.ca/fr/Equipe/Arthur-Juchereau)
- [Lena Krause](https://ecrituresnumeriques.ca/fr/Equipe/Lena-Krause)

## Technical Notes

This documentation website is built with the static site generator [11ty](https://www.11ty.dev/).
11 changes: 8 additions & 3 deletions docs/src/en/contacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@
title: Contact
---

Stylo is developed by the team at the [Canada Research Chair in Digital Textualities](https://ecrituresnumeriques.ca/en/Team) and *PiNinja* company.
## Contact us

For more information, you can contact us at the [Chair's email address](mailto:[email protected]).

For questions and discussion about Stylo, a helpdesk is open every Thursday morning from 11am to 12pm (Canadian time): <a class="btn btn-info" href="https://meet.jit.si/stylo" role="button">Reach the helpdesk
by videoconference</a>.
For questions and discussion about Stylo, a helpdesk is open every Thursday morning from 11am to 12pm (Canadian time): <a class="btn btn-info" href="https://meet.jit.si/stylo" role="button">Reach the helpdesk by videoconference</a>.

{% link-button "https://meet.jit.si/stylo", "hyperlink" %}Reach the helpdesk by videoconference{% endlink-button %}

We do consider specific requests that Stylo be adapted to particular editorial chains - like a journal, for example.

## Report a bug

Report problems and bugs on the [GitHub repository](https://github.com/EcrituresNumeriques/stylo/issues).

{% link-button "https://github.com/EcrituresNumeriques/stylo/issues/new", "hyperlink" %}Report a bug{% endlink-button %}
82 changes: 23 additions & 59 deletions docs/src/en/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
"lang": "en",
"description": "Stylo is a text editor that simplifies writing and editing scientific articles in the Human and Social Sciences.",
"rights": "Licence Creative Commons [CC BY-SA 4.0] – Canada Research Chair on digital textualities",
"sources": "<a href=\"https://github.com/EcrituresNumeriques/stylo/\">Sources</a>",
"contact": "<a href=\"/en/contacts/\">Contact us</a>",
"colophon": "<a href=\"/en/colophon\">Colophon</a>",

"sectionTitle": "Documentation",
"sectionUrl": "/en",
Expand All @@ -11,77 +14,38 @@
"searchIndexUrl": "/en/search-index.json",
"menu": [
{
"label": "News",
"url": "/en/news"
},
{
"label": "Project",
"label": "Language",
"children": [
{
"label": "About",
"url": "/en/about"
},
{
"label": "Sources",
"url": "/en/sources"
},
{
"label": "Contact",
"url": "/en/contacts"
"label": "English",
"url": "/en",
"lang": "en"
},
{
"label": "Publications",
"url": "/en/publications"
"label": "Français",
"url": "/fr",
"lang": "fr"
}
]
},

{
"label": "Writing guide",
"children": [
{ "label": "Getting started with Stylo", "url": "/en/firststeps" },
{ "label": "Writing in Markdown", "url": "/en/markdownsyntax" },
{ "label": "Writing in BibTeX", "url": "/en/bibtexsyntax" },
{ "label": "Writing in YAML", "url": "/en/yamlsyntax" }
]
},

{
"label": "Article management",
"children": [
{ "label": "Manage my article", "url": "/en/myarticles" },
{ "label": "Manage my bibliography", "url": "/en/managingref" },
{ "label": "Preview and annotate an article", "url": "/en/preview" },
{ "label": "Versioning content", "url": "/en/versioning" },
{ "label": "Manage my metadata", "url": "/en/metadata" }
]
},
{
"label": "Stylo features",
"children": [
{ "label": "Corpus", "url": "/en/corpus" },
{ "label": "Workspaces", "url": "/en/workspaces" },
{ "label": "Collaborative writing", "url": "/en/collaborative-writing" },
{ "label": "Monaco text editor", "url": "/en/monaco-editor" },
{ "label": "API GraphQL", "url": "/en/api-graphql" },
{ "label": "Exports", "url": "/en/exports" },
{ "label": "Dissertation and theses", "url": "/en/dissertation" },
{ "label": "Solving problems", "url": "/en/problems" }
]
},

{
"label": "Language",
"label": "Documentation",
"children": [
{
"label": "English",
"url": "/en",
"lang": "en"
"label": "Features",
"url": "/en/features"
},
{
"label": "Français",
"url": "/fr",
"lang": "fr"
"label": "User guides",
"url": "/en/user-guides"
},
{
"label": "Tutorials",
"url": "/en/tutorials"
},
{
"label": "FAQ",
"url": "/en/faq"
}
]
}
Expand Down
17 changes: 17 additions & 0 deletions docs/src/en/faq/faq.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"sectionTitle": "Foire aux questions",
"sectionUrl": "/en/faq",
"disableSearch": false,
"searchIndexUrl": "/en/search-index.json",
"menu": [
{
"label": "FAQ",
"children": [
{
"label": "Solving known problems",
"url": "/en/faq/problems"
}
]
}
]
}
5 changes: 5 additions & 0 deletions docs/src/en/faq/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Frequently asked questions"
---

Got a question? We're here ton answer! If you don't see your question here, drop us a line to our [Contact page](/en/contacts). 
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/src/en/exports.md → docs/src/en/features/exports.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Export Page
title: Exports
---

## Export en article
Expand Down
41 changes: 41 additions & 0 deletions docs/src/en/features/features.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"sectionTitle": "Features",
"sectionUrl": "/en/features",
"disableSearch": false,
"searchIndexUrl": "/en/search-index.json",
"menu": [
{
"label": "Features",
"children": [
{
"label": "Corpus",
"url": "/en/features/corpus"
},
{
"label": "Monaco text editor",
"url": "/en/features/monaco-editor"
},
{
"label": "Collaborative writing",
"url": "/en/features/collaborative-writing"
},
{
"label": "Workspaces",
"url": "/en/features/workspaces"
},
{
"label": "Exports",
"url": "/en/features/exports"
},
{
"label": "Preview and annotate an article",
"url": "/en/features/preview"
},
{
"label": "Versioning content",
"url": "/en/features/versioning"
}
]
}
]
}
5 changes: 5 additions & 0 deletions docs/src/en/features/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Stylo features"
---

Documentation of Stylo features.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
46 changes: 11 additions & 35 deletions docs/src/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,27 @@ title: Stylo - a semantic text editor
isHome: true
---

<alert-block heading="📢 Feature Update" type="success">

To Stylo users: The long-awaited synchronous collaborative writing feature is now available! To find out more, go to the [documentation page](/fr/edition-collaborative) which is dedicated to it!

</alert-block>


<alert-block heading="📢 Documentation update" type="neutral">

To the attention of Stylo users: the Stylo documentation has been updated! It has a new interface and a new structuring of its data!

</alert-block>

---

Attention Stylo users: the semantic text editor Stylo has just been updated. To discover the new features in detail, please visit the information page: [New features!](/en/newfeatures/).
Welcome to Stylo resource information. Stylo is a text editor that simplifies writing and editing scientific articles in the Human and Social Sciences.

---

**If you encounter any difficulties with Stylo, do not hesitate to contact us : [write here](mailto:[email protected]).**

A helpdesk is open every Thursday from 11am to 12pm (Montreal time) to respond to questions, improve the use of Stylo, share user experience or any concern or comment : <a class="btn btn-info" href="https://meet.jit.si/stylo" role="button">Reach the helpdesk by videoconference</a>
<link-button href="https://stylo.huma-num.fr" size="small" color="default">Test Stylo</link-button> &nbsp;

---

Welcome to Stylo resource information. Stylo is a text editor that simplifies writing and editing scientific articles in the Human and Social Sciences.

It is designed for authors and publishers engaged in quality scientific publishing.

Stylo's work environment encompasses a complete editorial chain based on [pandoc](https://pandoc.org/) and is equipped with the following modules:

- **A metadata editor**
- **A version manager**
- **A bibliographic manager**
- **Different export formats** : HTML5, XML (TEI, ÉruditArticle), PDF...
- **An annotation tool**
- **Sharing documents for collaborative editing**

Stylo is developed by the [Canada Research Chair in Digital Textualities](https://ecrituresnumeriques.ca/en/) and [PiNinja](https://3.14159.ninja/) company, with the support of[Érudit](https://www.erudit.org/en/) and of [Huma-Num](https://www.huma-num.fr/), under [GPL-3.0](https://github.com/EcrituresNumeriques/stylo/blob/master/LICENSE) licence.

Stylo is now connected to [HumanID](https://humanid.huma-num.fr/) and accessible to all users with an account at Huma-Num. [Read more about this](https://humanum.hypotheses.org/6311).
Stylo's documentation is divided into several sections:
1. The _Features_ section contains descriptions of all Stylo features.
2. The user guides contain several scenarios to show you different uses of the features.
3. Tutorials cover the languages and formats used in Stylo (Markdown, YAML, BibTeX, GraphQL).
4. Frequently asked questions deal with known problems

---

<a class="btn btn-info" href="https://stylo.huma-num.fr" role="button">Test Stylo</a> <a class="btn btn-info" href="pages/firststeps.md" role="button">First steps</a> <a class="btn btn-info" href="https://ia601400.us.archive.org/16/items/stylo_202009/Stylo.mp4" role="button">Demo-video</a>
<link-button href="/fr/fonctionnalites" size="small" color="default">Features</link-button> &nbsp;
<link-button href="/fr/guides_utilisation" size="small" color="default">User guides</link-button> &nbsp;
<link-button href="/fr/tutoriels" size="small" color="default">Tutorials</link-button> &nbsp;
<link-button href="/fr/faq" size="small" color="default">Frequently asked questions</link-button> &nbsp;

---

Expand Down
5 changes: 0 additions & 5 deletions docs/src/en/news/index.md

This file was deleted.

Empty file removed docs/src/en/news/news.json
Empty file.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "API GraphQL"
title: "GraphQL API"
---

## Stylo's GraphQL API - An introduction
Expand Down
File renamed without changes.
5 changes: 5 additions & 0 deletions docs/src/en/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Tutorials"
---

Tutorials to help understanding Stylo.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Markdown syntax
title: Writing in Markdown
---

## Titles
Expand Down
Loading

0 comments on commit 8424b72

Please sign in to comment.