modelec/Documentations
1
0
Fork 0
mirror of https://github.com/modelec/Documentations.git synced 2026-01-18 16:37:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add a home page

Browse Source 
with a short presentation
This commit is contained in:
Florent
2024-03-29 15:42:06 +01:00
parent ce3e2e20a9
commit 0d846295b5
4 changed files with 17 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Writerside/gu.tree
View File

@@ -4,9 +4,9 @@
<instance-profile id="gu"
name="Guide d'utilisation"
start-page="starter-topic.md">
start-page="Présentation.md">
<toc-element topic="starter-topic.md"/>
<toc-element topic="Présentation.md"/>
<toc-element topic="Serge.md">
<toc-element topic="Odométrie.md"/>
<toc-element topic="Lidar.md"/>

4
Writerside/redirection-rules.xml
View File

@@ -10,4 +10,8 @@
<description><![CDATA[Created after removal of "<Serge.md>" from Guide d'utilisation]]></description>
<accepts>Serge.html</accepts>
</rule>
<rule id="475eea90">
<description>Created after removal of "About Guide d'utilisation" from Guide d'utilisation</description>
<accepts>starter-topic.html</accepts>
</rule>
</rules>

11
Writerside/topics/Présentation.md Normal file
View File

@@ -0,0 +1,11 @@
# Présentation
Ce projet s'inscrit dans le cadre de la participation à la Coupe de France de Robotique.
Le projet est séparé en deux parties : Le robot principal, Serge, et un PAMI, Pixel.
Lors du temps imparti, qui est de 100 secondes maximum, ce robot affrontera un autre robot pour réaliser les mêmes
objectifs.
Le robot principal a pour objectif principal de récupérer des plantes sur une table de jeux de 2 mètres par 3 mètres.
Par la suite, il devra les déplacer soit dans des zones de dépots au sol, soit dans des jardinières qui sont en hauteurs.

79
Writerside/topics/starter-topic.md
View File

@@ -1,79 +0,0 @@
# About Guide d'utilisation
<!--Writerside adds this topic when you create a new documentation project.
You can use it as a sandbox to play with Writerside features, and remove it from the TOC when you don't need it anymore.-->
## Add new topics
You can create empty topics, or choose a template for different types of content that contains some boilerplate structure to help you get started:
![Create new topic options](new_topic_options.png){ width=290 }{border-effect=line}
## Write content
%product% supports two types of markup: Markdown and XML.
When you create a new help article, you can choose between two topic types, but this doesn't mean you have to stick to a single format.
You can author content in Markdown and extend it with semantic attributes or inject entire XML elements.
## Inject XML
For example, this is how you inject a procedure:
<procedure title="Inject a procedure" id="inject-a-procedure">
<step>
<p>Start typing and select a procedure type from the completion suggestions:</p>
<img src="completion_procedure.png" alt="completion suggestions for procedure" border-effect="line"/>
</step>
<step>
<p>Press <shortcut>Tab</shortcut> or <shortcut>Enter</shortcut> to insert the markup.</p>
</step>
</procedure>
## Add interactive elements
### Tabs
To add switchable content, you can make use of tabs (inject them by starting to type `tab` on a new line):
<tabs>
<tab title="Markdown">
<code-block lang="plain text">![Alt Text](new_topic_options.png){ width=450 }</code-block>
</tab>
<tab title="Semantic markup">
<code-block lang="xml">
<![CDATA[<img src="new_topic_options.png" alt="Alt text" width="450px"/>]]></code-block>
</tab>
</tabs>
### Collapsible blocks
Apart from injecting entire XML elements, you can use attributes to configure the behavior of certain elements.
For example, you can collapse a chapter that contains non-essential information:
#### Supplementary info {collapsible="true"}
Content under a collapsible header will be collapsed by default,
but you can modify the behavior by adding the following attribute:
`default-state="expanded"`
### Convert selection to XML
If you need to extend an element with more functions, you can convert selected content from Markdown to semantic markup.
For example, if you want to merge cells in a table, it's much easier to convert it to XML than do this in Markdown.
Position the caret anywhere in the table and press <shortcut>Alt+Enter</shortcut>:
<img src="convert_table_to_xml.png" alt="Convert table to XML" width="706" border-effect="line"/>
## Feedback and support
Please report any issues, usability improvements, or feature requests to our
<a href="https://youtrack.jetbrains.com/newIssue?project=WRS">YouTrack project</a>
(you will need to register).
You are welcome to join our
<a href="https://jb.gg/WRS_Slack">public Slack workspace</a>.
Before you do, please read our [Code of conduct](https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-code-of-conduct.html).
We assume that you’ve read and acknowledged it before joining.
You can also always email us at [writerside@jetbrains.com](mailto:writerside@jetbrains.com).
<seealso>
<category ref="wrs">
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/markup-reference.html">Markup reference</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/manage-table-of-contents.html">Reorder topics in the TOC</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/local-build.html">Build and publish</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/configure-search.html">Configure Search</a>
</category>
</seealso>