-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstarter.html
More file actions
17 lines (17 loc) · 10.2 KB
/
starter.html
File metadata and controls
17 lines (17 loc) · 10.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2025-02-23T09:44:55.768325777"><title>Starter | Instance Name</title><script type="application/json" id="virtual-toc-data">[{"id":"add-new-topics","level":0,"title":"Add new topics","anchor":"#add-new-topics"},{"id":"write-content","level":0,"title":"Write content","anchor":"#write-content"},{"id":"inject-xml","level":0,"title":"Inject XML","anchor":"#inject-xml"},{"id":"add-interactive-elements","level":0,"title":"Add interactive elements","anchor":"#add-interactive-elements"},{"id":"feedback-and-support","level":0,"title":"Feedback and support","anchor":"#feedback-and-support"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b575/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Starter | Instance Name"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Instance Name Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/starter.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Starter | Instance Name"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
"@context": "http://schema.org",
"@type": "WebPage",
"@id": "writerside-documentation/starter.html#webpage",
"url": "writerside-documentation/starter.html",
"name": "Starter | Instance Name",
"description": "",
"image": "",
"inLanguage":"en-US"
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
"@type": "WebSite",
"@id": "writerside-documentation/#website",
"url": "writerside-documentation/",
"name": "Instance Name Help"
}</script><!-- End Schema.org --></head><body data-id="starter" data-main-title="Starter" data-article-props="{"seeAlso":[{"title":"Writerside documentation","links":[{"url":"https://www.jetbrains.com/help/writerside/markup-reference.html","text":"Markup reference"},{"url":"https://www.jetbrains.com/help/writerside/manage-table-of-contents.html","text":"Reorder topics in the TOC"},{"url":"https://www.jetbrains.com/help/writerside/local-build.html","text":"Build and publish"},{"url":"https://www.jetbrains.com/help/writerside/configure-search.html","text":"Configure Search"}]}],"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs=""><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Instance Name Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="starter" id="starter.md">Starter</h1><section class="chapter"><h2 id="add-new-topics" data-toc="add-new-topics">Add new topics</h2><p id="-mugeza_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:</p><figure id="-mugeza_10"><img alt="Create new topic options" src="images/new_topic_options.png" class="article__bordered-element" title="Create new topic options" data-dark-src="images/new_topic_options_dark.png" width="290" height="220"></figure></section><section class="chapter"><h2 id="write-content" data-toc="write-content">Write content</h2><p id="-mugeza_11">Writerside 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.</p></section><section class="chapter"><h2 id="inject-xml" data-toc="inject-xml">Inject XML</h2><p id="-mugeza_12">For example, this is how you inject a procedure:</p><section class="procedure-steps"><h3 id="inject-a-procedure" data-toc="inject-a-procedure">Inject a procedure</h3><ol class="list _decimal"><li class="list__item" id="-mugeza_14"><p id="-mugeza_16">Start typing and select a procedure type from the completion suggestions:</p><figure id="-mugeza_17"><img alt="completion suggestions for procedure" src="images/completion_procedure.png" class="article__bordered-element" title="completion suggestions for procedure" data-dark-src="images/completion_procedure_dark.png" width="1207" height="258"></figure></li><li class="list__item" id="-mugeza_15"><p id="-mugeza_18">Press <kbd class="keystroke" id="-mugeza_19" data-bypass="true"><span class="keystroke__value">Tab</span></kbd> or <kbd class="keystroke" id="-mugeza_20" data-bypass="true"><span class="keystroke__value">Enter</span></kbd> to insert the markup.</p></li></ol></section></section><section class="chapter"><h2 id="add-interactive-elements" data-toc="add-interactive-elements">Add interactive elements</h2><section class="chapter"><h3 id="tabs" data-toc="tabs">Tabs</h3><p id="-mugeza_24">To add switchable content, you can make use of tabs (inject them by starting to type <code class="code" id="-mugeza_26">tab</code> on a new line):</p><div class="tabs" id="-mugeza_25" data-anchors="[-mugeza_27,-mugeza_28]"><div class="tabs__content" data-gtm="tab" id="-mugeza_27" data-title="Markdown"><div class="code-block" data-lang="none" data-title="Plain Text">{ width=450 }</div></div><div class="tabs__content" data-gtm="tab" id="-mugeza_28" data-title="Semantic markup"><div class="code-block" data-lang="markup" data-title="XML">
<img src="new_topic_options.png" alt="Alt text" width="450px"/></div></div></div></section><section class="chapter"><h3 id="collapsible-blocks" data-toc="collapsible-blocks">Collapsible blocks</h3><p id="-mugeza_31">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:</p><section class="chapter"><div class="collapse"><div class="collapse__title"><h4 id="supplementary-info" data-toc="supplementary-info">Supplementary info</h4></div><div class="collapse__content"><p id="-mugeza_33">Content under a collapsible header will be collapsed by default, but you can modify the behavior by adding the following attribute: <code class="code" id="-mugeza_34">default-state="expanded"</code></p></div></div></section></section><section class="chapter"><h3 id="convert-selection-to-xml" data-toc="convert-selection-to-xml">Convert selection to XML</h3><p id="-mugeza_35">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 <kbd class="keystroke" id="-mugeza_37" data-bypass="true"><span class="keystroke__value">Alt+Enter</span></kbd>:</p><figure id="-mugeza_36"><img alt="Convert table to XML" src="images/convert_table_to_xml.png" class="article__bordered-element" title="Convert table to XML" data-dark-src="images/convert_table_to_xml_dark.png" width="706" height="196"></figure></section></section><section class="chapter"><h2 id="feedback-and-support" data-toc="feedback-and-support">Feedback and support</h2><p id="-mugeza_38">Please report any issues, usability improvements, or feature requests to our <a href="https://youtrack.jetbrains.com/newIssue?project=WRS" id="-mugeza_41" data-external="true" rel="noopener noreferrer">YouTrack project</a> (you will need to register).</p><p id="-mugeza_39">You are welcome to join our <a href="https://jb.gg/WRS_Slack" id="-mugeza_42" data-external="true" rel="noopener noreferrer">public Slack workspace</a>. Before you do, please read our <a href="https://www.jetbrains.com/help/writerside/writerside-code-of-conduct.html" id="-mugeza_43" data-external="true" rel="noopener noreferrer">Code of conduct</a>. We assume that you’ve read and acknowledged it before joining.</p><p id="-mugeza_40">You can also always email us at <a href="mailto:writerside@jetbrains.com" id="-mugeza_44" data-external="true">writerside@jetbrains.com</a>.</p></section><div class="last-modified">Last modified: 23 February 2025</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="installation-guide.html" class="navigation-links__next">Installation guide</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b575/app.js"></script></body></html>