diff options
Diffstat (limited to 'Writerside/topics/Default-topic.md')
| -rw-r--r-- | Writerside/topics/Default-topic.md | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/Writerside/topics/Default-topic.md b/Writerside/topics/Default-topic.md new file mode 100644 index 0000000..dd51468 --- /dev/null +++ b/Writerside/topics/Default-topic.md @@ -0,0 +1,80 @@ +# This is the first topic + +<!--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. +If you want to re-add it for your experiments, click + to create a new topic, choose Topic from Template, and select the +"Starter" template.--> + +## 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: + +{ 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">{ 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 such 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://join.slack.com/t/writerside/shared_invite/zt-1hnvxnl0z-Nc6RWXTppRI2Oc566vumYw">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 send an email to [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> |