|
| 1 | +# Welcome to Writerside! |
| 2 | + |
| 3 | +<!--Writerside adds this topic when you create a new documentation project. |
| 4 | +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. |
| 5 | +If you want to re-add it for your experiments, click + to create a new topic, choose Topic from Template, and select the |
| 6 | +"Starter" template.--> |
| 7 | + |
| 8 | +## Add new topics |
| 9 | +You can create empty topics, or choose a template for different types of content that contains some boilerplate structure to help you get started: |
| 10 | + |
| 11 | +{ width=290 }{border-effect=line} |
| 12 | + |
| 13 | +## Write content |
| 14 | +%product% supports two types of markup: Markdown and XML. |
| 15 | +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. |
| 16 | +You can author content in Markdown and extend it with semantic attributes or inject entire XML elements. |
| 17 | + |
| 18 | +## Inject XML |
| 19 | +For example, this is how you inject a procedure: |
| 20 | + |
| 21 | +<procedure title="Inject a procedure" id="inject-a-procedure"> |
| 22 | + <step> |
| 23 | + <p>Start typing and select a procedure type from the completion suggestions:</p> |
| 24 | + <img src="completion_procedure.png" alt="completion suggestions for procedure" border-effect="line"/> |
| 25 | + </step> |
| 26 | + <step> |
| 27 | + <p>Press <shortcut>Tab</shortcut> or <shortcut>Enter</shortcut> to insert the markup.</p> |
| 28 | + </step> |
| 29 | +</procedure> |
| 30 | + |
| 31 | +## Add interactive elements |
| 32 | + |
| 33 | +### Tabs |
| 34 | +To add switchable content, you can make use of tabs (inject them by starting to type `tab` on a new line): |
| 35 | + |
| 36 | +<tabs> |
| 37 | + <tab title="Markdown"> |
| 38 | + <code-block lang="plain text">{ width=450 }</code-block> |
| 39 | + </tab> |
| 40 | + <tab title="Semantic markup"> |
| 41 | + <code-block lang="xml"> |
| 42 | + <![CDATA[<img src="new_topic_options.png" alt="Alt text" width="450px"/>]]></code-block> |
| 43 | + </tab> |
| 44 | +</tabs> |
| 45 | + |
| 46 | +### Collapsible blocks |
| 47 | +Apart from injecting entire XML elements, you can use attributes to configure the behavior of certain elements. |
| 48 | +For example, you can collapse a chapter that contains non-essential information: |
| 49 | + |
| 50 | +#### Supplementary info {collapsible="true"} |
| 51 | +Content under such header will be collapsed by default, but you can modify the behavior by adding the following attribute: |
| 52 | +`default-state="expanded"` |
| 53 | + |
| 54 | +### Convert selection to XML |
| 55 | +If you need to extend an element with more functions, you can convert selected content from Markdown to semantic markup. |
| 56 | +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. |
| 57 | +Position the caret anywhere in the table and press <shortcut>Alt+Enter</shortcut>: |
| 58 | + |
| 59 | +<img src="convert_table_to_xml.png" alt="Convert table to XML" width="706" border-effect="line"/> |
| 60 | + |
| 61 | +## Feedback and support |
| 62 | +Please report any issues, usability improvements, or feature requests to our |
| 63 | +<a href="https://youtrack.jetbrains.com/newIssue?project=WRS">YouTrack project</a> |
| 64 | +(you will need to register). |
| 65 | + |
| 66 | +You are welcome to join our |
| 67 | +<a href="https://join.slack.com/t/writerside/shared_invite/zt-1hnvxnl0z-Nc6RWXTppRI2Oc566vumYw">public Slack workspace</a>. |
| 68 | +Before you do, please read our [Code of conduct](https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-code-of-conduct.html). |
| 69 | +We assume that you’ve read and acknowledged it before joining. |
| 70 | + |
| 71 | +You can also always send an email to [[email protected]](mailto:[email protected]). |
| 72 | + |
| 73 | +<seealso> |
| 74 | + <category ref="wrs"> |
| 75 | + <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/markup-reference.html">Markup reference</a> |
| 76 | + <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/manage-table-of-contents.html">Reorder topics in the TOC</a> |
| 77 | + <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/local-build.html">Build and publish</a> |
| 78 | + <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/configure-search.html">Configure Search</a> |
| 79 | + </category> |
| 80 | +</seealso> |
0 commit comments