Skip to content

Commit

Permalink
Build documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@jtmaston
jtmaston committed Dec 5, 2023
1 parent 7ebb9be commit 589606f
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/HelpTOC.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"entities":{"pages":{"Default-topic":{"id":"Default-topic","title":"CIMPLC","url":"default-topic.html","level":0,"tabIndex":0}}},"topLevelIds":["Default-topic"]}
1 change: 1 addition & 0 deletions docs/Map.jhm
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?xml version='1.0' encoding='UTF-8'?><map version="2.0"><mapID target="Default-topic.md" url="default-topic.html" default="yes"/><mapID target="Default-topic" url="default-topic.html" default="yes"/></map>
1 change: 1 addition & 0 deletions docs/config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"productVersion":"1.0","productId":"jtmaston.github.io/CIMPLC-Hardware","stage":"release","downloadTitle":"Get CIMPLC-Hardwaredocs","keymaps":{},"searchMaxHits":75,"productName":"CIMPLC-Hardwaredocs"}
1 change: 1 addition & 0 deletions docs/current.help.version
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.0
2 changes: 2 additions & 0 deletions docs/default-topic.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-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="2023-12-05T15:19:25.77025599"><meta name="build-number" content="${buildNumber}"> <title>CIMPLC | CIMPLC-Hardwaredocs</title><script id="virtual-toc-data" type="application/json">[{"id":"about-the-project","level":0,"title":"About the project","anchor":"#about-the-project"},{"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 id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.css" rel="stylesheet"> <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"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><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="CIMPLC | CIMPLC-Hardwaredocs"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="CIMPLC-Hardwaredocs Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="jtmaston.github.io/CIMPLC-Hardware/1.0/default-topic.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="CIMPLC | CIMPLC-Hardwaredocs"><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": "jtmaston.github.io/CIMPLC-Hardware/1.0/default-topic.html#webpage", "url": "jtmaston.github.io/CIMPLC-Hardware/1.0/default-topic.html", "name": "CIMPLC | CIMPLC-Hardwaredocs", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "jtmaston.github.io/CIMPLC-Hardware/#website", "url": "jtmaston.github.io/CIMPLC-Hardware/", "name": "CIMPLC-Hardwaredocs Help" }</script><!-- End Schema.org --></head> <body data-id="Default-topic" data-main-title="CIMPLC" data-article-props="{&quot;seeAlso&quot;:[{&quot;title&quot;:&quot;Writerside documentation&quot;,&quot;links&quot;:[{&quot;url&quot;:&quot;https://plugins.jetbrains.com/plugin/20158-writerside/docs/markup-reference.html&quot;,&quot;text&quot;:&quot;Markup reference&quot;},{&quot;url&quot;:&quot;https://plugins.jetbrains.com/plugin/20158-writerside/docs/manage-table-of-contents.html&quot;,&quot;text&quot;:&quot;Reorder topics in the TOC&quot;},{&quot;url&quot;:&quot;https://plugins.jetbrains.com/plugin/20158-writerside/docs/local-build.html&quot;,&quot;text&quot;:&quot;Build and publish&quot;},{&quot;url&quot;:&quot;https://plugins.jetbrains.com/plugin/20158-writerside/docs/configure-search.html&quot;,&quot;text&quot;:&quot;Configure Search&quot;}]}],&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>CIMPLC-Hardwaredocs 1.0 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="Default-topic" id="Default-topic.md">CIMPLC</h1> <section class="chapter"><h2 id="about-the-project" data-toc="about-the-project" >About the project</h2><p id="423a2245_50">The CIMPLC is a low-cost, open source high pin-count programmable logic controller, designed as a project while studying at the University of Politehnica, Bucharest. It is designed as a replacement for the aging hardware found inside the CIM ( Computer Integrated Manufacturing ) located in our faculty.</p><p id="423a2245_51">Designed to replace aging hardware (old Festo PLCs from cca 1993, whose datasheets and manuals are unavailable), the goal of the CIMPLC is to emulate the functionality of its industrial-grade counterparts, but maintain an accessible price point. First and foremost, however, it is a learning project, in order to help understand what designing such a system would entail.</p><p id="423a2245_52">While I took all the necessary precautions to ensure that the device is functional and operational, note that it is a student project and should absolutely <span class="control" id="423a2245_53">not</span> be used in an industrial application. Your mileage may vary. Please see the &quot;errata&quot; section for errors in the design, and how they were remedied.</p><figure id="423a2245_54"><img alt="Create new topic options" src="CIMPLC-Hardware/new_topic_options.png" class="article__bordered-element" title="Create new topic options" data-dark-src="CIMPLC-Hardware/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="423a2245_55">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="423a2245_56">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="423a2245_57"><p id="423a2245_58">Start typing and select a procedure type from the completion suggestions:</p><figure id="423a2245_59"><img alt="completion suggestions for procedure" src="CIMPLC-Hardware/completion_procedure.png" class="article__bordered-element" title="completion suggestions for procedure" data-dark-src="CIMPLC-Hardware/completion_procedure_dark.png" width="1207" height="258"></figure></li><li class="list__item" id="423a2245_60"><p id="423a2245_61">Press <kbd class="keystroke" id="423a2245_62" data-bypass="true"><span class="keystroke__value">Tab</span></kbd> or <kbd class="keystroke" id="423a2245_63" 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="423a2245_64">To add switchable content, you can make use of tabs (inject them by starting to type <code class="code" id="423a2245_65">tab</code> on a new line):</p><div class="tabs" id="423a2245_66"><div class="tabs__content" data-gtm="tab" id="423a2245_67" data-title="Markdown"><div class="code-block" data-lang="plaintext" data-title="Plain Text" >![Alt Text](new_topic_options.png){ width=450 }</div></div><div class="tabs__content" data-gtm="tab" id="423a2245_69" data-title="Semantic markup"><div class="code-block" data-lang="markup" data-title="XML" >
&lt;img src=&quot;new_topic_options.png&quot; alt=&quot;Alt text&quot; width=&quot;450px&quot;/&gt;</div></div></div></section><section class="chapter"><h3 id="collapsible-blocks" data-toc="collapsible-blocks" >Collapsible blocks</h3><p id="423a2245_71">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="423a2245_72">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="423a2245_73">default-state=&quot;expanded&quot;</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="423a2245_74">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="423a2245_75" data-bypass="true"><span class="keystroke__value">Alt+Enter</span></kbd>:</p><figure id="423a2245_76"><img alt="Convert table to XML" src="CIMPLC-Hardware/convert_table_to_xml.png" class="article__bordered-element" title="Convert table to XML" data-dark-src="CIMPLC-Hardware/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="423a2245_77">Please report any issues, usability improvements, or feature requests to our <a href="https://youtrack.jetbrains.com/newIssue?project=WRS" id="423a2245_78" data-external="true" rel="noopener noreferrer" >YouTrack project</a> (you will need to register).</p><p id="423a2245_79">You are welcome to join our <a href="https://jb.gg/WRS_Slack" id="423a2245_80" data-external="true" rel="noopener noreferrer" >public Slack workspace</a>. Before you do, please read our <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-code-of-conduct.html" id="423a2245_81" data-external="true" rel="noopener noreferrer" >Code of conduct</a>. We assume that you&rsquo;ve read and acknowledged it before joining.</p><p id="423a2245_82">You can also always email us at <a href="mailto:[email protected]" id="423a2245_83" data-external="true" >[email protected]</a>.</p></section><div class="last-modified"> Last modified: 05 December 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.js"></script></body></html>
4 changes: 2 additions & 2 deletions docs/docfiles/hi.tree → docs/docfiles/cimplc.tree
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">

<instance-profile id="hi"
name="Help Instance"
<instance-profile id="cimplc"
name="CIMPLC-Hardwaredocs"
start-page="Default-topic.md">

<toc-element topic="Default-topic.md"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/docfiles/writerside.cfg
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
<images dir="images" web-path="CIMPLC-Hardware"/>
<categories src="c.list"/>
<vars src="v.list"/>
<instance src="hi.tree"/>
<instance src="cimplc.tree" version="1.0" web-path="jtmaston.github.io/CIMPLC-Hardware"/>
</ihp>
9 changes: 9 additions & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html lang="en-US">
<meta charset="utf-8">
<title>You will be redirected shortly</title>
<meta http-equiv="refresh" content="0; url=default-topic.html">
<h1>Redirecting&hellip;</h1>
<a href="default-topic.html">Click here if you are not redirected.</a>
<script>location = "default-topic.html"</script>
</html>

0 comments on commit 589606f

Please sign in to comment.