Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ecarriou committed Jun 14, 2019
1 parent 7887fac commit ccf4d1b
Show file tree
Hide file tree
Showing 18 changed files with 78 additions and 39 deletions.
2 changes: 1 addition & 1 deletion documentation/docs/en/bundle-your-css.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ <h2><a class="anchor" aria-hidden="true" id="install-your-bundle-in-another-syst
<span class="hljs-tag">&lt;<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"system"</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"application/json"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"system2.json"</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">head</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/system-runtime@3.1.1/dist/system-runtime.min.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/system-runtime@3.2.0/dist/system-runtime.min.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">body</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">html</span>&gt;</span>
</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/en/bundle-your-html.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ <h2><a class="anchor" aria-hidden="true" id="install-your-bundle-in-another-syst
<span class="hljs-tag">&lt;<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"system"</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"application/json"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"system2.json"</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">head</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/system-runtime@3.1.1/dist/system-runtime.min.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/system-runtime@3.2.0/dist/system-runtime.min.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">body</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">html</span>&gt;</span>
</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/en/bundle-your-javascript.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h3><a class="anchor" aria-hidden="true" id="client-side-example"></a><a href="#
<span class="hljs-tag">&lt;<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"system"</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"application/json"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"system2.json"</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">head</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/system-runtime@3.1.1/dist/system-runtime.min.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/system-runtime@3.2.0/dist/system-runtime.min.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">body</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">html</span>&gt;</span>
</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/en/create-a-graph-system.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">Create a Graph system</h1></header><article><div><span><blockquote>
<p><strong>version compatibility</strong></p>
<p>This feature is only available on the <strong>Windows 10</strong>, <strong>macOS</strong> and <strong>HTML5</strong> versions of <em>System Designer</em>.</p>
<p>This feature is only available on the <strong>Windows</strong>, <strong>macOS</strong>, <strong>Linux</strong> and <strong>PWA</strong> versions of <em>System Designer</em>.</p>
</blockquote>
<p>In this tutorial we will show how to create a Graph.</p>
<h2><a class="anchor" aria-hidden="true" id="create-a-graph-system"></a><a href="#create-a-graph-system" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Create a Graph system</h2>
Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/en/create-an-extension.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h2><a class="anchor" aria-hidden="true" id="create-an-action-when-clicking-on-t
<h2><a class="anchor" aria-hidden="true" id="test-your-extension"></a><a href="#test-your-extension" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Test your extension</h2>
<p>To test your extension, it is very easy. You just have to click on the run button and your extension will be installed in System Designer.</p>
<p><img src="../../img/8f12ab7-run.png" alt="Image Alt"></p>
<h2><a class="anchor" aria-hidden="true" id="debug-your-extension-on-macos-and-windows-10"></a><a href="#debug-your-extension-on-macos-and-windows-10" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Debug your extension on macOS and Windows 10</h2>
<h2><a class="anchor" aria-hidden="true" id="debug-your-extension-on-macos-windows-or-linux"></a><a href="#debug-your-extension-on-macos-windows-or-linux" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Debug your extension on macOS, Windows or Linux</h2>
<ul>
<li>go to the menu,</li>
<li>click on <strong>Menu &gt; Toggle Developper Tools</strong>.</li>
Expand All @@ -129,4 +129,4 @@ <h2><a class="anchor" aria-hidden="true" id="add-your-extension"></a><a href="#a
<ul>
<li>your extension is then been added into System Designer. You will be able to remove it from the same dialog.</li>
</ul>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="../../docs/en/send-messages-to-other-systems.html"><span class="arrow-prev"></span><span>Send messages to other systems</span></a><a class="docs-next button" href="../../docs/en/generate-a-model-from-a-json-file.html"><span>Generate a model from a JSON file</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#create-an-extension">Create an extension</a></li><li><a href="#create-a-toolbar-item">Create a toolbar item</a></li><li><a href="#create-an-action-when-clicking-on-the-toolbar-item">Create an action when clicking on the toolbar item</a></li><li><a href="#test-your-extension">Test your extension</a></li><li><a href="#debug-your-extension-on-macos-and-windows-10">Debug your extension on macOS and Windows 10</a></li><li><a href="#add-your-extension">Add your extension</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">System Designer is distributed under Apache License 2.0 - Copyright © 2019 Erwan Carriou</section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="../../docs/en/send-messages-to-other-systems.html"><span class="arrow-prev"></span><span>Send messages to other systems</span></a><a class="docs-next button" href="../../docs/en/generate-a-model-from-a-json-file.html"><span>Generate a model from a JSON file</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#create-an-extension">Create an extension</a></li><li><a href="#create-a-toolbar-item">Create a toolbar item</a></li><li><a href="#create-an-action-when-clicking-on-the-toolbar-item">Create an action when clicking on the toolbar item</a></li><li><a href="#test-your-extension">Test your extension</a></li><li><a href="#debug-your-extension-on-macos-windows-or-linux">Debug your extension on macOS, Windows or Linux</a></li><li><a href="#add-your-extension">Add your extension</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">System Designer is distributed under Apache License 2.0 - Copyright © 2019 Erwan Carriou</section></footer></div></body></html>
4 changes: 2 additions & 2 deletions documentation/docs/en/design-a-remote-client-system.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,14 @@
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">Design a remote client system</h1></header><article><div><span><blockquote>
<p><strong>Version compatibility</strong></p>
<p>This feature is only available on the <strong>Windows 10</strong>, <strong>macOS</strong> and <strong>HTML5</strong> versions of <em>System Designer</em>.</p>
<p>This feature is only available on the <strong>Windows</strong>, <strong>macOS</strong>, <strong>Linux</strong> and <strong>PWA</strong> versions of <em>System Designer</em>.</p>
</blockquote>
<p>With System Designer you can import a system of a running system on a remote server. You can then update the system from System Designer. All modifications to the system will be then send to the running app.</p>
<blockquote>
<p>Enable design mode on your running system</p>
</blockquote>
<p>To enable <em>design</em> mode on your application, just add <a href="https://github.com/design-first/system-runtime/tree/master/extensions">mode-admin extension</a> in the HTML of your page that contains your system:</p>
<pre><code class="hljs css language-html"><span class="hljs-tag">&lt;<span class="hljs-name">link</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/system-runtime@3.1.1/extensions/mode-admin.json"</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"application/json"</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"system"</span>&gt;</span>
<pre><code class="hljs css language-html"><span class="hljs-tag">&lt;<span class="hljs-name">link</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/system-runtime@3.2.0/extensions/mode-admin.json"</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"application/json"</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"system"</span>&gt;</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="set-the-url-of-the-page"></a><a href="#set-the-url-of-the-page" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Set the url of the page</h2>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/en/design-a-remote-server-system.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
});
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">Design a remote server system</h1></header><article><div><span><blockquote>
<p><strong>Version compatibility</strong></p>
<p>This feature is only available on the <strong>Windows 10</strong>, <strong>macOS</strong> and <strong>HTML5</strong> versions of <em>System Designer</em>.</p>
<p>This feature is only available on the <strong>Windows</strong>, <strong>macOS</strong>, <strong>Linux</strong> and <strong>PWA</strong> versions of <em>System Designer</em>.</p>
</blockquote>
<p>With System Designer you can import a system of a running app on a remote server. You can then update the system from System Designer. All modifications to the system will be then send to the running system.</p>
<h2><a class="anchor" aria-hidden="true" id="enable-design-mode-on-your-running-system"></a><a href="#enable-design-mode-on-your-running-system" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Enable design mode on your running system</h2>
Expand Down
Loading

0 comments on commit ccf4d1b

Please sign in to comment.