Released HastyScribe 1.6.0.
h3rald h3rald@h3rald.com
Sun, 12 Mar 2017 20:36:03 +0100
2 files changed,
63 insertions(+),
40 deletions(-)
M
content/hastyscribe.erb
→
content/hastyscribe.erb
@@ -7,10 +7,10 @@ type: project
github: hastyscribe links: - "User Guide": /hastyscribe/HastyScribe_UserGuide.htm -- "Download": https://github.com/h3rald/hastyscribe/releases/v1.5.0 +- "Download": https://github.com/h3rald/hastyscribe/releases/v1.6.0 - "Source": https://github.com/h3rald/hastyscribe status: Active -version: 1.5.0 +version: 1.6.0 ----- <div class="jumbotron">@@ -80,27 +80,27 @@ <span class="fa-download"></span> Download <span class="caret"></span>
</button> <ul class="dropdown-menu" role="menu" style="text-align: left;"> <li> - <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_macosx_x64.zip"> + <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_macosx_x64.zip"> <i class="h3-os-apple"></i> HastyScribe for OS X (x64) </a> </li> <li> - <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_linux_x64.zip"> + <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_linux_x64.zip"> <i class="h3-os-linux"></i> HastyScribe for Linux (x64) </a> </li> <li> - <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_linux_x86.zip"> + <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_linux_x86.zip"> <i class="h3-os-linux"></i> HastyScribe for Linux (x86) </a> </li> <li> - <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_linux_arm.zip"> + <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_linux_arm.zip"> <i class="h3-os-linux"></i> HastyScribe for Linux (ARM) </a> </li> <li> - <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_windows_x64.zip"> + <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_windows_x64.zip"> <i class="h3-os-win-04"></i> HastyScribe for Windows (x64) </a> </li>
M
content/hastyscribe/HastyScribe_UserGuide.htm
→
content/hastyscribe/HastyScribe_UserGuide.htm
@@ -4355,6 +4355,7 @@ <li><a href="#Standard-Markdown">Standard Markdown</a></li>
<li><a href="#Discount-Extensions">Discount Extensions</a></li> <li><a href="#Text-Snippets">Text Snippets</a></li> <li><a href="#Custom-Fields">Custom Fields</a></li> + <li><a href="#Content-Transclusion">Content Transclusion</a></li> <li><a href="#Substitution-Macros">Substitution Macros</a></li> <li><a href="#Image-(and-font)-Embedding">Image (and font) Embedding</a></li> <li><a href="#FontAwesome-Icons">FontAwesome Icons</a></li>@@ -4383,6 +4384,7 @@ </li>
<li><a href="#Syntax-Reference">Syntax Reference</a> <ul> <li><a href="#Document-Headers">Document Headers</a></li> + <li><a href="#Transclusion">Transclusion</a></li> <li><a href="#Snippets">Snippets</a></li> <li><a href="#Fields">Fields</a></li> <li><a href="#Macros">Macros</a></li>@@ -4466,7 +4468,7 @@ <p>HastyScribe supports standard markdown for formatting text. Markdown is a lightweight markup language created by John Gruber, and used on many web sites and programs to enable users to write HTML code <em>without actually writing HTML tags</em>.</p>
<div class="tip"><p>Tip</p> -<p>You can learn about Markdown syntax in the <a href="#Syntax.Reference">Syntax Reference</a> section of this document. Alternatively, you can also read the original <a href="https://daringfireball.net/projects/markdown/syntax">Markdown syntax page</a> on John Gruber’s blog, Daring Fireball.</p></div> +<p>You can learn about Markdown syntax in the <a href="#Syntax-Reference">Syntax Reference</a> section of this document. Alternatively, you can also read the original <a href="https://daringfireball.net/projects/markdown/syntax">Markdown syntax page</a> on John Gruber’s blog, Daring Fireball.</p></div> <a name="Discount-Extensions"></a> <h4>Discount Extensions<a href="#document-top" title="Go to top"></a></h4>@@ -4490,6 +4492,11 @@ <h4>Custom Fields<a href="#document-top" title="Go to top"></a></h4>
<p>HastyScribe also supports <a href="#Fields">fields</a> to easily include things like the current date or time, but also custom values specified as command-line parameters.</p> +<a name="Content-Transclusion"></a> +<h4>Content Transclusion<a href="#document-top" title="Go to top"></a></h4> + +<p>When managing long documents, you can take advantage of HastyScribe’s <a href="#Transclusion">transclusion</a> support to split your content into several files, and transclude them as you see fit.</p> + <a name="Substitution-Macros"></a> <h4>Substitution Macros<a href="#document-top" title="Go to top"></a></h4>@@ -4539,11 +4546,11 @@
<p>The easiest way to get HastyScribe is by downloading one of the prebuilt binaries from the <a href="https://github.com/h3rald/hastyscribe/releases/download/v">Github Release Page</a>:</p> <ul> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_macos_x64.zip">HastyScribe for Mac OS X (x64)</a> – Compiled on Mac OS X Sierra (LLVM CLANG 8.0.0)</li> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_windows_x64.zip">HastyScribe for Windows (x64)</a> – Cross-compiled on Mac OS X Sierra (MinGW-w64 GCC 4.8.2)</li> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_linux_x64.zip">HastyScribe for Linux (x64)</a> – Cross-compiled on Mac OS X Sierra (GNU GCC 4.8.1)</li> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_linux_x86.zip">HastyScribe for Linux (x86)</a> – Cross-compiled on Mac OS X Sierra (GNU GCC 4.8.1)</li> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.5.0/hastyscribe_v1.5.0_linux_arm.zip">HastyScribe for Linux (ARM)</a> – Cross-compiled on Mac OS X Sierra (GNU GCC 4.8.2)</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_macos_x64.zip">HastyScribe for Mac OS X (x64)</a> – Compiled on Mac OS X Sierra (LLVM CLANG 8.0.0)</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_windows_x64.zip">HastyScribe for Windows (x64)</a> – Cross-compiled on Mac OS X Sierra (MinGW-w64 GCC 4.8.2)</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_linux_x64.zip">HastyScribe for Linux (x64)</a> – Cross-compiled on Mac OS X Sierra (GNU GCC 4.8.1)</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_linux_x86.zip">HastyScribe for Linux (x86)</a> – Cross-compiled on Mac OS X Sierra (GNU GCC 4.8.1)</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.6.0/hastyscribe_v1.6.0_linux_arm.zip">HastyScribe for Linux (ARM)</a> – Cross-compiled on Mac OS X Sierra (GNU GCC 4.8.2)</li> </ul>@@ -4648,12 +4655,29 @@ <li>If you want to use the current date, enter <span class="kwd">% -</span> in the third line.</li>
</ul> </div> +<a name="Transclusion"></a> +<h3>Transclusion<a href="#document-top" title="Go to top"></a></h3> + +<p>When writing a long document, it is often useful to split it into many different files, to manage its contents better. HastyScribe provides basic content transclusion support through the following syntax:</p> + +<p><code>{@ my-file.md || 1 @}</code></p> + +<p>When a file is processed, the line above will cause the contents of file <span class="file">my-file.md</span> to be included in the current file, as if they were part of it. Additionally, when using content transclusion syntax, it is mandatory to specify a number between 0 and 5 to indicate the <em>offset</em> of the headings present in the transcluded file. In this example, the heading numbers of all headings present in <span class="file">my-file.md</span> will be increased by 1, so any <span class="kwd">h2</span> will become <span class="kwd">h3</span>, any <span class="kwd">h3</span> will become <span class="kwd">h4</span>, and so on.</p> + +<div class="warning"><p>Limitations</p> + +<ul> +<li>It is recommended to place all transcluded files in the same folder as the transcluding file. If a transcluded file includes any image, its relative path will be interpreted as if it was relative to the transcluding file.</li> +<li>Heading offset will only work if headings are created using <span class="kwd">#</span>s. Underline syntax for <span class="kwd">h1</span> and <span class="kwd">h2</span> is not supported.</li> +</ul> +</div> + <a name="Snippets"></a> <h3>Snippets<a href="#document-top" title="Go to top"></a></h3> <p>If you want to reuse a few words or even entire blocks of texts, you can use HastyScribe’s snippets.</p> -<p>A snippet definition is constituted by an identifier, followed by an arrow (->), followed by some text – all wrapped in double curly brackets.</p> +<p>A snippet definition is constituted by an identifier, followed by an arrow (<span class="kwd">-></span>), followed by some text – all wrapped in double curly brackets.</p> <p>The following definition creates a snippet called <span class="kwd">test</span> which is transformed into the text “This is a test snippet.”.</p>@@ -4661,13 +4685,11 @@ <p><code>{{test -> This is a test snippet.}}</code></p>
<p>Once a snippet is defined <em>anywhere</em> in the document, you can use its identifier wrapped in double curly brackets (<code>{{test}}}</code> in the previous example) anywhere in the document to reuse the specified text.</p> -<div class="note"><p>Remarks</p> +<div class="sidebar"><p>Alternative Snippet Definition Syntax</p> + +<p>When a document is compiled, both snippets <em>and snippet defininotions</em> are evaluated to their body text. To avoid snippet definitions being evaluated, you can use a double arrow (<span class="kwd">=></span>) in the definition:</p> -<ul> -<li>It doesn’t matter where a snippet is defined. Snippets can be used anywhere in the document, before or after their definition.</li> -<li>When a document is compiled, both snippets <em>and snippets definitions</em> are evaluated their body text.</li> -</ul> -</div> +<p><code>{{test => This snippet definition will not be evaluated to its body text.}}</code></p></div> <a name="Fields"></a> <h3>Fields<a href="#document-top" title="Go to top"></a></h3>@@ -4684,59 +4706,59 @@ </thead>
<tbody> <tr> <td><code>{{$timestamp}}</code> </td> -<td> 1487863280</td> +<td> 1489321436</td> </tr> <tr> <td><code>{{$date}}</code> </td> -<td> 2017-02-23</td> +<td> 2017-03-12</td> </tr> <tr> <td><code>{{$full-date}}</code> </td> -<td> Thursday, February 23, 2017</td> +<td> Sunday, March 12, 2017</td> </tr> <tr> <td><code>{{$long-date}}</code> </td> -<td> February 23, 2017</td> +<td> March 12, 2017</td> </tr> <tr> <td><code>{{$medium-date}}</code> </td> -<td> Feb 23, 2017</td> +<td> Mar 12, 2017</td> </tr> <tr> <td><code>{{$short-date}}</code> </td> -<td> 2/23/17</td> +<td> 3/12/17</td> </tr> <tr> <td><code>{{$short-time}}</code> </td> -<td> 16:21 PM</td> +<td> 13:23 PM</td> </tr> <tr> <td><code>{{$short-time-24}}</code> </td> -<td> 16:21</td> +<td> 13:23</td> </tr> <tr> <td><code>{{$time}}</code> </td> -<td> 16:21:20 PM</td> +<td> 13:23:56 PM</td> </tr> <tr> <td><code>{{$time-24}}</code> </td> -<td> 16:21:20</td> +<td> 13:23:56</td> </tr> <tr> <td><code>{{$day}}</code> </td> -<td> 23</td> +<td> 12</td> </tr> <tr> <td><code>{{$short-day}}</code> </td> -<td> 23</td> +<td> 12</td> </tr> <tr> <td><code>{{$month}}</code> </td> -<td> 02</td> +<td> 03</td> </tr> <tr> <td><code>{{$short-month}}</code> </td> -<td> 2</td> +<td> 3</td> </tr> <tr> <td><code>{{$year}}</code> </td>@@ -4748,19 +4770,19 @@ <td> 17</td>
</tr> <tr> <td><code>{{$weekday}}</code> </td> -<td> Thursday</td> +<td> Sunday</td> </tr> <tr> <td><code>{{$weekday-abbr}}</code> </td> -<td> 23</td> +<td> 12</td> </tr> <tr> <td><code>{{$month-name}}</code> </td> -<td> February</td> +<td> March</td> </tr> <tr> <td><code>{{$month-name-abbr}}</code> </td> -<td> Feb</td> +<td> Mar</td> </tr> <tr> <td><code>{{$timezone-offset}}</code> </td>@@ -4781,7 +4803,7 @@ <h3>Macros<a href="#document-top" title="Go to top"></a></h3>
<p>If snippets are not enough, and you want to reuse chunks of <em>similar</em> content, you can define substitution macros using the following syntax:</p> -<p><code>{#greet -> Hello, $1! Are you $2?#}</code></p> +<p><code>{#greet => Hello, $1! Are you $2?#}</code></p> <p>This defines a macro called <span class="kwd">greet</span> that takes two parameters which will be substituted instead of <span class="kwd">$1</span> and <span class="kwd">$2</span>. To use the macro, use the following syntax:</p>@@ -4793,6 +4815,7 @@ <ul>
<li>Like snippets, macros can be multiline.</li> <li>Spaces and newline character are preseved ad the start and end of parameters.</li> <li>You can use snippets and fields within macros (but you cannot nest macros inside other macros).</li> +<li>You can define macros using either <span class="kwd">-></span> or <span class="kwd">=></span>, although <span class="kwd">=></span> is preferred.</li> </ul> </div>@@ -5675,7 +5698,7 @@
<p style="text-align:center;"> <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFgAAAAfCAYAAABjyArgAAAGa0lEQVRo3u1aW08bRxTmuSqIV0SlIFWtAKkVtEpfWiVI6Q+gT60qpeIhTXkrSpqoaZ1AkJMobSRkkUahEtAWCVWBYMDcfME22MZ3rw0hrzzwAxC/4FTfrGeYXXa9u8Y0yGGkEeu5nGW+OfOdy2wDETU1NDTQea19JcKf8o/lwBKthlbIH16j0EaQwrEwbSSiFEvFaCuToFQuSel8mrKFDOWULOWKObUqWcoqGcrk02wMxsZTMTY3EgszWf6wn8nGO3xri7SwOk/zy16aW3pJL32zrM4uztDMwou6qRLQR+AGIn5a3wxRNB6hWHKTgZXOpxiAhVKeijsKlV4VaXt3m3ZeqxXPpVcl1ocxWSXL5mAuZEQTESYTsvUge5fnBMgAuE5BbtCCm4gyDUxmk0xbARpAdT9w05Uvr1BjU+Oxo4A29LkfutnYwnaBbQo0Op6OM21e31zXgLy4tkDzK14VZN8RyHdcd6ijo+PYO9CGPruLOwtyBMCgBRlcAJMrZplWekY91Nraapt3MNbz1MPmgkKgzQkBckjQxZLfR4urKsjQ4j/GnlJ7R7uQ09PTQwMDA6zimbdjzOjzUdNFoe+syBEAgydBC0fg5pgm9n7VqwGvubmZ+vr6aGhoiCKRCKt4Rhv65LGYG0/GKF9SQYYmgy5UTl6jleCyoIp/pv+mpqYmdV5vL+3t7ZG+oA19GIOxRouanJo4U3IEwDBo4EvQAjRXDy7AA5AHBwdUqUxOTmqAxu4CZGwYNg7vgOELRgO0tr6qUsXqgjiC2Ci5SNZY8w4uW78grnF6OZ6REfr2629OLMdszWZyBMA4vjBK4FwcbRncrq4uwx00K9gEzJE1GTLByXjHEVWoWnx30CU05fXuriXAKFxzZA7EM9o+6e6mP5+PacBtaWmhxncb6fbNn2h/f9+WHKP/x6wYydEAHGPUkGIGDZwrg2ultXZABifD8DGqSMUoEle1GFzc0alqr5NNxFhuaPhi+Clo/+BDev9CG13+/Avq//46a8Ppe/TwEXuenZmxJeek/48GYKa9SoZRAzdoOOqKolC1BSBzuoBMyIYLx7U4tKFqMTcg+oLjyTfI6KhyQyMvBm23btykn2/dZiDzyjXXSCPN5MhFliXXSnI0AIMf86U8c8X4orDrJy2cn1DhwuGEcC4Ol9029MEy64tBVKQpmKMHRpaTSiYZsLIM/NaDbCUHpf+HfsNaSY4GYERoyo7CfFmuvTI1wFsAz2CXUGXw9X0jIyOaF3MthmxwMSI+mSZOC2BeoLkAtvujj4XmweAF/H5HcqxKRYBh3HCEeRAhH0kAaOTvAkyv12vYJ8/nRx2yEfGBihJlly0YDdacIuRyeHhIE+Pj7Bmaqz/i4On/hSKQT9jeLYkFyVrIjVVbWxsjcwCOZxx/3sc9DQDO+4xoAmF1TsPDQers7DQ1Kmbaa9c4QVMBBLQXldMEDN29X110ofU9W3KuX7tmWG0bOfi+yCvwBQFE/SKNONkOX8snAO+AT7yV2RIAD96/J9wiuwBbuVcyPbjvDws3DS4btNqpnBO7aW8SYAQc3FWzE2hwrnMSIDz57fdjgUY1cipxb8VAwy5FwPDBdcMzQJUpQt9nlyIA8PSL6foOlSsZuUqGzI6R4zusGrkie5ds5ADwUsBHU/9OabJW2DTIwXw5aLFK0gAcOUnzJuUcc9N4iAzXSn/Mzdw0gMzb9X0o0GjZTUtLblogEhCZNZYfXpqjX+7WYbqSBxpymKz3Z2sZaGyWAw2kLnlWjact6+l2QwCcSBuHyk7i8WpDZTn5XrcAy8meib/Ga5/sGfUw2Uj24F08ZSkn3vnNRj1dHQmAUV2DLpGuvPrdVQ3ITpI+0HrDdGUhQ8MPht/G2+WjHwM3fmRuVLGKhDv6MEZOuF/87CKjBvjZrnLe960GGBUJcAQDAFnW5GqujABuvpijZ2PP7H5HYBhk6MfYkWP22yyZ5EROpaSUJcACZEW99AQnO770HOWXnlnb4BoBYbQwJxtVab7djaqBHOMO0IV8bQ/QrK7tcXPBru3xfUQh45gWrNKVTjfK7G8t5VQNMLvf+rSbvIte5sLBT1bEhycl6cOTEmuTPzyZ93np0uVL1XxqdCJqsKKEajS4BnKs/2GA9fjJYwpFQ9KnU+WKT6cKGdaHMdUAe1oafGY5+LzWsBLRO+dAnN7Xlf8BOGLNYHeHmZwAAAAASUVORK5CYII=" alt="Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 Unported License" /></p> </div> <div id="footer"> - <p><span class="copy"></span> Fabio Cevasco – February 23, 2017</p> + <p><span class="copy"></span> Fabio Cevasco – March 12, 2017</p> <p><span>Powered by</span> <a href="https://h3rald.com/hastyscribe"><span class="hastyscribe"></span></a></p> </div> </div>