dist/HastyStyles_TestDocument.htm
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 |
<!doctype html>
<html lang="en">
<head>
<title>HastyStyles Test Document</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="Fabio Cevasco">
<meta name="generator" content="HastyScribe">
<style>
@import url('hastystyles.css');
@import url('hastystyles.badges.css');
@import url('hastystyles.notes.css');
@import url('hastystyles.icons.css');
@import url('hastystyles.links.css');
</style>
</head>
<body class="headings">
<div id="container">
<a id="document-top"></a>
<div id="header"><h1>HastyStyles Test Document</h1></div>
<div id="toc"><ul>
<li>
<ul>
<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>
<li><a href="#Inline-Formatting">Inline Formatting</a>
<ul>
<li><a href="#SmartyPants-Substitutions">SmartyPants Substitutions</a></li>
<li><a href="#Icons">Icons</a></li>
<li><a href="#Badges">Badges</a></li>
<li><a href="#Anchors">Anchors</a></li>
<li><a href="#Links">Links</a></li>
</ul>
</li>
<li><a href="#Block-level-Formatting">Block-level Formatting</a>
<ul>
<li><a href="#Headings">Headings</a></li>
<li><a href="#Tables">Tables</a></li>
<li><a href="#Block-Quotes">Block Quotes</a></li>
<li><a href="#Code-Blocks">Code Blocks</a></li>
<li><a href="#Images">Images</a></li>
<li><a href="#Lists">Lists</a>
<ul>
<li><a href="#Unordered-Lists">Unordered Lists</a></li>
<li><a href="#Ordered-Lists">Ordered Lists</a></li>
<li><a href="#Alphabetical-Lists">Alphabetical Lists</a></li>
<li><a href="#Checklists">Checklists</a></li>
<li><a href="#Unstyled-Lists">Unstyled Lists</a></li>
<li><a href="#Nested-Lists">Nested Lists</a></li>
<li><a href="#Definition-Lists">Definition Lists</a></li>
</ul>
</li>
<li><a href="#Class-Blocks">Class Blocks</a>
<ul>
<li><a href="#Notes">Notes</a></li>
<li><a href="#Tips">Tips</a></li>
<li><a href="#Warnings">Warnings</a></li>
<li><a href="#Sidebars">Sidebars</a></li>
<li><a href="#Blank-Sidebars">Blank Sidebars</a></li>
<li><a href="#Terminal-Sessions">Terminal Sessions</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div id="main">
<a name="Syntax-Reference"></a>
<h2>Syntax Reference<a href="#document-top" title="Go to top"></a></h2>
<a name="Document-Headers"></a>
<h3>Document Headers<a href="#document-top" title="Go to top"></a></h3>
<p>HastyScribe supports <a href="http://johnmacfarlane.net/pandoc/">Pandoc</a>-style Document Headers, as implemented by the <a href="http://www.pell.portland.or.us/~orc/Code/discount/">Discount</a> library. Basically, you can specify the title of the document, author and date as the first three lines of the document, prepending each with a <span class="kwd">%</span>, like this</p>
<pre><code>% HastyScribe User Guide
% Fabio Cevasco
% -
</code></pre>
<div class="warning"><p>Important</p>
<ul>
<li>The order of the document headers is significant.</li>
<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 (<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>
<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="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>
<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>
<p>Besides user-defined snippets, HastyScribe also support fields, which can be used to insert current time and date information in a variety of formats:</p>
<div class="responsive"><table>
<thead>
<tr>
<th>Source </th>
<th> Output</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>{{$timestamp}}</code> </td>
<td> 1693396493</td>
</tr>
<tr>
<td><code>{{$date}}</code> </td>
<td> 2023-08-30</td>
</tr>
<tr>
<td><code>{{$full-date}}</code> </td>
<td> Wednesday, August 30, 2023</td>
</tr>
<tr>
<td><code>{{$long-date}}</code> </td>
<td> August 30, 2023</td>
</tr>
<tr>
<td><code>{{$medium-date}}</code> </td>
<td> Aug 30, 2023</td>
</tr>
<tr>
<td><code>{{$short-date}}</code> </td>
<td> 8/30/23</td>
</tr>
<tr>
<td><code>{{$short-time}}</code> </td>
<td> 13:54 PM</td>
</tr>
<tr>
<td><code>{{$short-time-24}}</code> </td>
<td> 13:54</td>
</tr>
<tr>
<td><code>{{$time}}</code> </td>
<td> 13:54:53 PM</td>
</tr>
<tr>
<td><code>{{$time-24}}</code> </td>
<td> 13:54:53</td>
</tr>
<tr>
<td><code>{{$day}}</code> </td>
<td> 30</td>
</tr>
<tr>
<td><code>{{$short-day}}</code> </td>
<td> 30</td>
</tr>
<tr>
<td><code>{{$month}}</code> </td>
<td> 08</td>
</tr>
<tr>
<td><code>{{$short-month}}</code> </td>
<td> 8</td>
</tr>
<tr>
<td><code>{{$year}}</code> </td>
<td> 2023</td>
</tr>
<tr>
<td><code>{{$short-year}}</code> </td>
<td> 23</td>
</tr>
<tr>
<td><code>{{$weekday}}</code> </td>
<td> Wednesday</td>
</tr>
<tr>
<td><code>{{$weekday-abbr}}</code> </td>
<td> 30</td>
</tr>
<tr>
<td><code>{{$month-name}}</code> </td>
<td> August</td>
</tr>
<tr>
<td><code>{{$month-name-abbr}}</code> </td>
<td> Aug</td>
</tr>
<tr>
<td><code>{{$timezone-offset}}</code> </td>
<td> +02:00</td>
</tr>
</tbody>
</table>
</div>
<p>Additionally, you can define your own custom fields via command-line parameters, using the <span class="arg">–field/</span> dynamic parameter, like this:</p>
<div class="terminal"><p>hastyscribe my-document.md –field/product:HastyScribe –field/version:1.2.0</p></div>
<p>In this case it will be possible to access the <span class="kwd">product</span> and <span class="kwd">product</span> fields within <span class="file">my-document.md</span> using <code>{{$product}}</code> and <code>{{$version}}</code>.</p>
<a name="Macros"></a>
<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>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>
<p><code>{#greet||Fabio||ready#}</code></p>
<div class="note"><p>Note</p>
<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>
<a name="Inline-Formatting"></a>
<h3>Inline Formatting<a href="#document-top" title="Go to top"></a></h3>
<p>The following table lists all the most common ways to format inline text:</p>
<div class="responsive"><table>
<thead>
<tr>
<th>Source </th>
<th> Output</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>**strong emphasis**</code> or <code>__strong emphasis__</code> </td>
<td> <strong>strong emphasis</strong></td>
</tr>
<tr>
<td><code>*emphasis*</code> or <code>_emphasis_</code> </td>
<td> <em>emphasis</em></td>
</tr>
<tr>
<td><code>~~deleted text~~</code> </td>
<td> <del>deleted text</del></td>
</tr>
<tr>
<td><code><ins>inserted text<ins></code> </td>
<td> <ins>inserted text</ins></td>
</tr>
<tr>
<td><code>`code`</code> </td>
<td> <code>code</code></td>
</tr>
<tr>
<td><code>[HTML](abbr:Hypertext Markup Language)</code> </td>
<td> <abbr title="Hypertext Markup Language">HTML</abbr></td>
</tr>
<tr>
<td><code><kbd>CTRL</kbd>+<kbd>C</kbd></code> </td>
<td> <kbd>CTRL</kbd>+<kbd>C</kbd></td>
</tr>
<tr>
<td><code><mark>marked</mark></code> </td>
<td> <mark>marked</mark>.</td>
</tr>
<tr>
<td><code>Sample output: <samp>This is a test.</samp></code> </td>
<td> Sample output: <samp>This is a test.</samp></td>
</tr>
<tr>
<td><code>Set the variable <var>test</var> to 1.</code> </td>
<td> Set the variable <var>test</var> to 1.</td>
</tr>
<tr>
<td><code><q>This is a short quotation</q></code> </td>
<td> <q>This is a short quotation</q></td>
</tr>
<tr>
<td><code><cite>Hamlet</cite>, by William Shakespeare.</code> </td>
<td> <cite>Hamlet</cite>, by William Shakespeare.</td>
</tr>
<tr>
<td><code>A [.md](class:ext) file</code> </td>
<td> A <span class="ext">.md</span> file</td>
</tr>
<tr>
<td><code>[my_markdown_file.md](class:file) file</code> </td>
<td> <span class="file">my_markdown_file.md</span> file</td>
</tr>
</tbody>
</table>
</div>
<div class="tip"><p>Tip</p>
<p>The <span class="kwd">kwd</span>, <span class="kwd">opt</span>, <span class="kwd">file</span>, <span class="kwd">dir</span>, <span class="kwd">arg</span>, <span class="kwd">tt</span> and <span class="kwd">cmd</span> classes are all rendered as inline monospace text. <span class="kwd">kwd</span> and <span class="ext">ext</span> are also rendered in bold.</p></div>
<a name="SmartyPants-Substitutions"></a>
<h4>SmartyPants Substitutions<a href="#document-top" title="Go to top"></a></h4>
<p>Special characters can be easily entered using some special character sequences.</p>
<p>HastyScribe supports all the sequences supported by <a href="http://www.pell.portland.or.us/~orc/Code/discount/">Discount</a>:</p>
<ul>
<li><code>`` text‘’</code> → “text”.</li>
<li><code>"double-quoted text"</code> → “double-quoted text”</li>
<li><code>'single-quoted text'</code> → ‘single-quoted text’</li>
<li><code>don't</code> → don’t. as well as anything-else’t. (But foo'tbar is just foo'tbar.)</li>
<li><code>it's</code> → it’s, as well as anything-else’s (except not foo'sbar and the like.)</li>
<li><code>(tm)</code> → ™</li>
<li><code>(r)</code> → ®</li>
<li><code>(c)</code> → ©</li>
<li><code>1/4th</code> → ¼th. Same goes for ½ and ¾.</li>
<li><code>...</code> or <code>. . .</code> → …</li>
<li><code>---</code> → —</li>
<li><code>--</code> → –</li>
<li><code>A^B</code> becomes A<sup>B</sup>. Complex superscripts can be enclosed in brackets, so <code>A^(B+2)</code> → A<sup>B+2</sup>.</li>
</ul>
<a name="Icons"></a>
<h4>Icons<a href="#document-top" title="Go to top"></a></h4>
<p>HastyScribe bundles the <a href="http://fortawesome.github.io/Font-Awesome/">FontAwesome</a> icon font. To prepend an icon to text you can use Discount’s <em>class:</em> pseudo-protocol, and specify a valid <span class="kwd">fa-*</span> (non-alias) class.</p>
<p>Examples:</p>
<div class="responsive"><table>
<thead>
<tr>
<th>Source </th>
<th> Output</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>[a paper plane](class:fa-paper-plane)</code> </td>
<td> <span class="fa-paper-plane"> a paper plane</span></td>
</tr>
<tr>
<td><code>[Galactic Empire](class:fa-empire)</code> </td>
<td> <span class="fa-empire"> Galactic Empire</span></td>
</tr>
<tr>
<td><code>[Rebel Alliance](class:fa-rebel)</code> </td>
<td> <span class="fa-rebel"> Rebel Alliance</span></td>
</tr>
</tbody>
</table>
</div>
<div class="tip"><p>Tip</p>
<p>See the <a href="http://fortawesome.github.io/Font-Awesome/icons/">FontAwesome Icon Reference</a> for a complete list of all CSS classes to use for icons (aliases are not supported).</p></div>
<a name="Badges"></a>
<h4>Badges<a href="#document-top" title="Go to top"></a></h4>
<p>Badges are shorthands for <a href="#Icons">Icons</a> formatted with different colors. To add a <em>badge</em> to some inline text, use the corresponding class among those listed in the following table. For example, the following code:</p>
<pre><code>[Genoa, Italy](class:badge-geo)
</code></pre>
<p>produces the following result:</p>
<p><span class="badge-geo">Genoa, Italy</span></p>
<p>HastyScribe currently supports the following badges:</p>
<div class="responsive"><table>
<thead>
<tr>
<th>Class </th>
<th> Badge </th>
<th> Class </th>
<th> Badge</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>badge-todo</code> </td>
<td> <span class="badge-todo"></span> </td>
<td><code>badge-user</code> </td>
<td> <span class="badge-user"></span></td>
</tr>
<tr>
<td><code>badge-fixme</code> </td>
<td> <span class="badge-fixme"></span> </td>
<td><code>badge-tag</code> </td>
<td> <span class="badge-tag"></span></td>
</tr>
<tr>
<td><code>badge-deadline</code> </td>
<td> <span class="badge-deadline"></span> </td>
<td><code>badge-tags</code> </td>
<td> <span class="badge-tags"></span></td>
</tr>
<tr>
<td><code>badge-comment</code> </td>
<td> <span class="badge-comment"></span> </td>
<td><code>badge-attachment</code> </td>
<td> <span class="badge-attachment"></span></td>
</tr>
<tr>
<td><code>badge-urgent</code> </td>
<td> <span class="badge-urgent"></span> </td>
<td><code>badge-bug</code> </td>
<td> <span class="badge-bug"></span></td>
</tr>
<tr>
<td><code>badge-verify</code> </td>
<td> <span class="badge-verify"></span> </td>
<td><code>badge-geo</code> </td>
<td> <span class="badge-geo"></span></td>
</tr>
<tr>
<td><code>badge-project</code> </td>
<td> <span class="badge-project"></span> </td>
<td><code>badge-square</code> </td>
<td> <span class="badge-square"></span></td>
</tr>
<tr>
<td><code>badge-star</code> </td>
<td> <span class="badge-star"></span> </td>
<td><code>badge-check</code> </td>
<td> <span class="badge-check"></span></td>
</tr>
<tr>
<td><code>badge-heart</code> </td>
<td> <span class="badge-heart"></span> </td>
<td><code>badge-rss</code> </td>
<td> <span class="badge-rss"></span></td>
</tr>
<tr>
<td><code>badge-lock</code> </td>
<td> <span class="badge-lock"></span> </td>
<td><code>badge-danger</code> </td>
<td> <span class="badge-danger"></span></td>
</tr>
<tr>
<td><code>badge-unlock</code> </td>
<td> <span class="badge-unlock"></span> </td>
<td><code>badge-question</code> </td>
<td> <span class="badge-question"></span></td>
</tr>
<tr>
<td><code>badge-folder</code> </td>
<td> <span class="badge-folder"></span> </td>
<td><code>badge-flag</code> </td>
<td> <span class="badge-flag"></span></td>
</tr>
<tr>
<td><code>badge-story</code> </td>
<td> <span class="badge-story"></span> </td>
<td><code>badge-feature</code> </td>
<td> <span class="badge-feature"></span></td>
</tr>
<tr>
<td><code>badge-add</code> </td>
<td> <span class="badge-add"></span> </td>
<td><code>badge-remove</code> </td>
<td> <span class="badge-remove"></span></td>
</tr>
<tr>
<td><code>badge-time</code> </td>
<td> <span class="badge-time"></span> </td>
<td><code>badge-date</code> </td>
<td> <span class="badge-date"></span></td>
</tr>
<tr>
<td><code>badge-html5</code> </td>
<td> <span class="badge-html5"></span> </td>
<td><code>badge-css3</code> </td>
<td> <span class="badge-css3"></span></td>
</tr>
<tr>
<td><code>badge-apple</code> </td>
<td> <span class="badge-apple"></span> </td>
<td><code>badge-windows</code> </td>
<td> <span class="badge-windows"></span></td>
</tr>
<tr>
<td><code>badge-linux</code> </td>
<td> <span class="badge-linux"></span> </td>
<td><code>badge-android</code> </td>
<td> <span class="badge-android"></span></td>
</tr>
<tr>
<td><code>badge-freebsd</code> </td>
<td> <span class="badge-freebsd"></span> </td>
<td><code>badge-aws</code> </td>
<td> <span class="badge-aws"></span></td>
</tr>
<tr>
<td><code>badge-idea</code> </td>
<td> <span class="badge-idea"></span> </td>
<td><code>badge-link</code> </td>
<td> <span class="badge-link"></span></td>
</tr>
<tr>
<td><code>badge-chrome</code> </td>
<td> <span class="badge-chrome"></span> </td>
<td><code>badge-firefox</code> </td>
<td> <span class="badge-firefox"></span></td>
</tr>
<tr>
<td><code>badge-ie</code> </td>
<td> <span class="badge-ie"></span> </td>
<td><code>badge-edge</code> </td>
<td> <span class="badge-edge"></span></td>
</tr>
<tr>
<td><code>badge-safari</code> </td>
<td> <span class="badge-safari"></span> </td>
<td><code>badge-opera</code> </td>
<td> <span class="badge-opera"></span></td>
</tr>
<tr>
<td><code>badge-php</code> </td>
<td> <span class="badge-php"></span> </td>
<td><code>badge-erlang</code> </td>
<td> <span class="badge-erlang"></span></td>
</tr>
<tr>
<td><code>badge-python</code> </td>
<td> <span class="badge-python"></span> </td>
<td><code>badge-java</code> </td>
<td> <span class="badge-java"></span></td>
</tr>
<tr>
<td><code>badge-nodejs</code> </td>
<td> <span class="badge-nodejs"></span> </td>
<td><code>badge-js</code> </td>
<td> <span class="badge-js"></span></td>
</tr>
<tr>
<td><code>badge-toggle-on</code> </td>
<td> <span class="badge-toggle-on"></span> </td>
<td><code>badge-toggle-off</code> </td>
<td> <span class="badge-toggle-off"></span></td>
</tr>
<tr>
<td><code>badge-debian</code> </td>
<td> <span class="badge-debian"></span> </td>
<td><code>badge-fedora</code> </td>
<td> <span class="badge-fedora"></span></td>
</tr>
<tr>
<td><code>badge-centos</code> </td>
<td> <span class="badge-centos"></span> </td>
<td><code>badge-suse</code> </td>
<td> <span class="badge-suse"></span></td>
</tr>
<tr>
<td><code>badge-redhat</code> </td>
<td> <span class="badge-redhat"></span> </td>
<td><code>badge-ubuntu</code> </td>
<td> <span class="badge-ubuntu"></span></td>
</tr>
<tr>
<td><code>badge-rust</code> </td>
<td> <span class="badge-rust"></span> </td>
<td><code>badge-go</code> </td>
<td> <span class="badge-go"></span></td>
</tr>
<tr>
<td><code>badge-rpi</code> </td>
<td> <span class="badge-rpi"></span> </td>
<td><code>badge-markdown</code> </td>
<td> <span class="badge-markdown"></span></td>
</tr>
<tr>
<td><code>badge-react</code> </td>
<td> <span class="badge-react"></span> </td>
<td><code>badge-angular</code> </td>
<td> <span class="badge-angular"></span></td>
</tr>
<tr>
<td><code>badge-vue</code> </td>
<td> <span class="badge-vue"></span> </td>
<td><code>badge-code</code> </td>
<td> <span class="badge-code"></span></td>
</tr>
<tr>
<td><code>badge-address</code> </td>
<td> <span class="badge-address"></span> </td>
<td><code>badge-org</code> </td>
<td> <span class="badge-org"></span></td>
</tr>
<tr>
<td><code>badge-toxic</code> </td>
<td> <span class="badge-toxic"></span> </td>
<td><code>badge-network</code> </td>
<td> <span class="badge-network"></span></td>
</tr>
<tr>
<td><code>badge-upload</code> </td>
<td> <span class="badge-upload"></span> </td>
<td><code>badge-download</code> </td>
<td> <span class="badge-download"></span></td>
</tr>
</tbody>
</table>
</div>
<a name="Anchors"></a>
<h4>Anchors<a href="#document-top" title="Go to top"></a></h4>
<p>You can define HTML anchors inline by wrapping their ID in hashes. For example, the following code:</p>
<pre><code> Some text goes here. #some_text#
</code></pre>
<p>Is converted to:</p>
<pre><code> Some text goes here. <a id="some_text"></a>
</code></pre>
<div class="note"><p>Note</p>
<ul>
<li>Anchor markup must be preceded by at least one space.</li>
<li>IDs must start with a letter, and can contain letters, numbers, and any of the following characters: <code>_</code> <code>-</code> <code>.</code> <code>:</code></li>
</ul>
</div>
<a name="Links"></a>
<h4>Links<a href="#document-top" title="Go to top"></a></h4>
<div class="responsive"><table>
<thead>
<tr>
<th>Source </th>
<th> Output</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>[H3RALD](https://h3rald.com/)</code> </td>
<td> <a href="https://h3rald.com/">H3RALD</a></td>
</tr>
<tr>
<td><code>[H3RALD](https://h3rald.com/ "H3RALD")</code></td>
<td> <a href="https://h3rald.com/" title="H3RALD">H3RALD</a></td>
</tr>
<tr>
<td><code><https://h3rald.com></code> </td>
<td> <a href="https://h3rald.com">https://h3rald.com</a></td>
</tr>
</tbody>
</table>
</div>
<p>Additionally, you can define placeholders for URLs and link titles, like this:</p>
<p><code>[h3rald]: https://h3rald.com/ "Fabio Cevasco's Web Site"</code></p>
<p>And use them in hyperlinks (note the usage of square brackets instead of round brackets):</p>
<p><code>[H3RALD][h3rald]</code></p>
<div class="sidebar"><p>Link Icons</p>
<p>HastyScribe automatically adds an envelope icon to email links, an arrow icon to links to external web sites, and logo icons to links to well-known web sites:</p>
<ul>
<li><a href="mailto:h3rald@h3rald.com">h3rald@h3rad.com</a></li>
<li><a href="https://twitter.com/h3rald">@h3rald</a></li>
<li><a href="https://it.linkedin.com/in/fabiocevasco">fabiocevasco</a></li>
</ul>
</div>
<a name="Block-level-Formatting"></a>
<h3>Block-level Formatting<a href="#document-top" title="Go to top"></a></h3>
<a name="Headings"></a>
<h4>Headings<a href="#document-top" title="Go to top"></a></h4>
<p>Headings can be specified simply by prepending <span class="kwd">#</span>s to text, as follows:</p>
<pre><code># Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
</code></pre>
<div class="note"><p>Note</p>
<p>If you use <a href="#Document-Headers">Document Headers</a>, A <span class="kwd">H1</span> is used for the title of the HastyScribe document. Within the document, start using headings from <span class="kwd">H2</span>.</p></div>
<a name="Tables"></a>
<h4>Tables<a href="#document-top" title="Go to top"></a></h4>
<p>HastyScribe supports [PHP Markdown Extra][pme] table syntax using pipes and dashes.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>Column Header 1 | Column Header 2 | Column Header 3
----------------|-----------------|----------------
Cell 1,1 | Cell 1,2 | Cell 1, 3
Cell 2,1 | Cell 2,2 | Cell 2, 3
Cell 3,1 | Cell 3,2 | Cell 3, 3
</code></pre>
<p>Produces the following output:</p>
<table>
<thead>
<tr>
<th>Column Header 1 </th>
<th> Column Header 2 </th>
<th> Column Header 3</th>
</tr>
</thead>
<tbody>
<tr>
<td>Cell 1,1 </td>
<td> Cell 1,2 </td>
<td> Cell 1, 3</td>
</tr>
<tr>
<td>Cell 2,1 </td>
<td> Cell 2,2 </td>
<td> Cell 2, 3</td>
</tr>
<tr>
<td>Cell 3,1 </td>
<td> Cell 3,2 </td>
<td> Cell 3, 3</td>
</tr>
</tbody>
</table>
<div class="note"><p>Note</p>
<p>Multi-row cells are not supported. If you need more complex tables, use HTML code instead.</p></div>
<div class="sidebar"><p>Responsive Tables</p>
<p>To make tables responsive, put them in a <em>responsive</em> block, like in the previous example. The <span class="kwd">responsive</span> class causes a table not to shrink and makes it scrollable horizontally on small devices.</p></div>
<a name="Block-Quotes"></a>
<h4>Block Quotes<a href="#document-top" title="Go to top"></a></h4>
<p>Block quotes can be created simply by prepending a <span class="kwd">></span> to a line, and they can be nested by prepending additional <span class="kwd">></span>s.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> This is a block quote.
> > This is a nested quote.
</code></pre>
<p>Produces the following output:</p>
<blockquote><p>This is a block quote.</p>
<blockquote><p>This is a nested quote.</p></blockquote></blockquote>
<a name="Code-Blocks"></a>
<h4>Code Blocks<a href="#document-top" title="Go to top"></a></h4>
<p>To format a block of source code, indent it by at least four spaces. Here’s the result:</p>
<pre><code>proc encode_image_file*(file, format): string =
if (file.existsFile):
let contents = file.readFile
return encode_image(contents, format)
else:
echo("Warning: image '"& file &"' not found.")
return file
</code></pre>
<p>Alternatively, you can also use Github-style fenced blocks, by adding three tildes (~~~) or backticks (```) before and after the source code.</p>
<div class="warning"><p>Warning</p>
<p>HastyScribe does not support syntax highlighting for code blocks. To do so, it would require Javascript and HastyScribe is currently kept purposedly “Javascript-free”.</p></div>
<a name="Images"></a>
<h4>Images<a href="#document-top" title="Go to top"></a></h4>
<p>The following HastyScribe Markdown code:</p>
<pre><code>
</code></pre>
<p>Produces the following output:</p>
<p><img src="./images/hastyscribe.png" height="65" width="221" alt="HastyScribe Logo" /></p>
<div class="tip"><p>Tip</p>
<p>You can use URL placeholders for images as well, exactly like for links.</p></div>
<div class="warning"><p>Limitations on automatic image download</p>
<p>HastyScribe will attempt to download all HTTP image links. Note that:</p>
<ul>
<li>If no response is received within 5 seconds, the download will be aborted.</li>
<li>Connecting through a proxy is currently not supported.</li>
<li>To download an image via HTTPS, you must explicitly recompile HastyScribe with <span class="kwd">-d:ssl</span> and OpenSSL must be installed on your system.</li>
</ul>
<p>If HastyScribe is unable to download an image, it will leave it linked.</p></div>
<a name="Lists"></a>
<h4>Lists<a href="#document-top" title="Go to top"></a></h4>
<a name="Unordered-Lists"></a>
<h5>Unordered Lists<a href="#document-top" title="Go to top"></a></h5>
<p>The following HastyScribe Markdown code:</p>
<pre><code>* An item
* Another item
* And another...
</code></pre>
<p>Produces the following output:</p>
<ul>
<li>An item</li>
<li>Another item</li>
<li>And another…</li>
</ul>
<a name="Ordered-Lists"></a>
<h5>Ordered Lists<a href="#document-top" title="Go to top"></a></h5>
<p>The following HastyScribe Markdown code:</p>
<pre><code>1. First item
2. Second item
3. Third item
</code></pre>
<p>Produces the following output:</p>
<ol>
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
</ol>
<div class="tip"><p>Tip</p>
<p>You don’t have to write numbers in order – any number followed by a dot will do.</p></div>
<a name="Alphabetical-Lists"></a>
<h5>Alphabetical Lists<a href="#document-top" title="Go to top"></a></h5>
<p>The following HastyScribe Markdown code:</p>
<pre><code>a. First item
b. Second item
c. Third item
</code></pre>
<p>Produces the following output:</p>
<ol type="a">
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
</ol>
<div class="tip"><p>Tip</p>
<p>You don’t have to write letters in order – any letter followed by a dot will do.</p></div>
<a name="Checklists"></a>
<h5>Checklists<a href="#document-top" title="Go to top"></a></h5>
<p>The following HastyScribe Markdown code:</p>
<pre><code>- [ ] Do something
- [ ] Do something else
- [x] Done!
</code></pre>
<p>Produces the following output:</p>
<ul>
<li class="github_checkbox"><input disabled="" type="checkbox"/> Do something</li>
<li class="github_checkbox"><input disabled="" type="checkbox"/> Do something else</li>
<li class="github_checkbox"><input disabled="" type="checkbox" checked="checked"/> Done!</li>
</ul>
<a name="Unstyled-Lists"></a>
<h5>Unstyled Lists<a href="#document-top" title="Go to top"></a></h5>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> %unstyled%
> * An item
> * Another item
> * And another...
</code></pre>
<p>Produces the following output:</p>
<div class="unstyled"><ul>
<li>An item</li>
<li>Another item</li>
<li>And another…</li>
</ul>
</div>
<a name="Nested-Lists"></a>
<h5>Nested Lists<a href="#document-top" title="Go to top"></a></h5>
<p>To create a list within a list, simply indent the whole nested list with four space.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>* This is a normal list
* Another item
* A nested unordered list
* Another item
* Back in the main list
a. A nested alphabetical list
b. Another item
</code></pre>
<p>Produces the following output:</p>
<ul>
<li>This is a normal list</li>
<li>Another item
<ul>
<li>A nested unordered list</li>
<li>Another item</li>
</ul>
</li>
<li>Back in the main list
<ol type="a">
<li> A nested alphabetical list</li>
<li> Another item</li>
</ol>
</li>
</ul>
<a name="Definition-Lists"></a>
<h5>Definition Lists<a href="#document-top" title="Go to top"></a></h5>
<p>In some cases you may want to write a list of terms and their corresponding definitions. You could use an ordinary unordered list, but semantically speaking the <em>proper</em> type of list to use in this case is a definition list.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>unordered list
: A list for unordered items. Also called _bulleted list_.
ordered list
: A list for ordered items. Also called _numbered list_.
alphabetical list
: Technically speaking just an ordered list, but formatted with letters instead
of numbers
definition list
: A list of terms and definitions.
</code></pre>
<p>Produces the following output:</p>
<dl>
<dt>unordered list</dt>
<dd>A list for unordered items. Also called <em>bulleted list</em>.</dd>
<dt>ordered list </dt>
<dd>A list for ordered items. Also called <em>numbered list</em>.</dd>
<dt>alphabetical list</dt>
<dd>Technically speaking just an ordered list, but formatted with letters instead
of numbers</dd>
<dt>definition list</dt>
<dd>A list of terms and definitions.</dd>
</dl>
<p>Alternatively, you can write the above definition list as follows:</p>
<pre><code>=unordered list=
A list for unordered items. Also called _bulleted list_.
=ordered list=
A list for ordered items. Also called _numbered list_.
=alphabetical list=
Technically speaking just an ordered list, but formatted with letters instead
of numbers
=definition list=
A list of terms and definitions.
</code></pre>
<a name="Class-Blocks"></a>
<h4>Class Blocks<a href="#document-top" title="Go to top"></a></h4>
<a name="Notes"></a>
<h5>Notes<a href="#document-top" title="Go to top"></a></h5>
<p><a href="http://www.pell.portland.or.us/~orc/Code/discount/">Discount</a> supports the definition of <em>class blocks</em>: <span class="kwd">div</span>s with a class attribute. The syntax is very similar to the one used for <a href="#Block-Quotes">block quotes</a>, with the addition of the class name wrapped in <span class="kwd">%</span>s on the first line.</p>
<p>In HastyScribe , this syntax is used to produce notes, <a href="#Tips">tips</a>, <a href="#Warnings">warmings</a>, <a href="#Sidebars">sidebars</a> and <a href="#Terminal-Sessions">terminal sessions</a>.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> %note%
> Note
>
> This is a note.
</code></pre>
<p>Produces the following output:</p>
<div class="note"><p>Note</p>
<p>This is a note.</p></div>
<a name="Tips"></a>
<h5>Tips<a href="#document-top" title="Go to top"></a></h5>
<p>Tips are used for optional information that can help the user in some way.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> %tip%
> Tip
>
> This is a tip.
</code></pre>
<p>Produces the following output:</p>
<div class="tip"><p>Tip</p>
<p>This is a tip.</p></div>
<a name="Warnings"></a>
<h5>Warnings<a href="#document-top" title="Go to top"></a></h5>
<p>Warnings are used for important information the user should not overlook.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> %warning%
> Warning
>
> This is a warning or an important note.
</code></pre>
<p>Produces the following output:</p>
<div class="warning"><p>Warning</p>
<p>This is a warning or an important note.</p></div>
<a name="Sidebars"></a>
<h5>Sidebars<a href="#document-top" title="Go to top"></a></h5>
<p>Sidebars are used for digressions and asides.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> %sidebar%
> This is a _sidebar_
>
> Although not always placed on the side of the page, _sidebars_ contain
> additional content and asides.
</code></pre>
<p>Produces the following output:</p>
<div class="sidebar"><p>This is a <em>sidebar</em></p>
<p>Although not always placed on the side of the page, <em>sidebars</em> contain additional content and asides.</p></div>
<a name="Blank-Sidebars"></a>
<h5>Blank Sidebars<a href="#document-top" title="Go to top"></a></h5>
<p>Blank sidebars can be customized to include custom icons. They are suitable for conditional (operating system or browser specific) instructions.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> %blank-sidebar%
> [](class:chrome)[](class:firefox)[](class:edge) Browser Support
>
> This web app supports only modern browsers, i.e. the latest versions of Google Chrome, Mozilla Firefox and Microsoft Edge, but _not_ Microsoft Internet Explorer.
</code></pre>
<p>Produces the following output:</p>
<div class="blank-sidebar"><p><span class="chrome"></span><span class="firefox"></span><span class="edge"></span> Browser Support</p>
<p>This web app supports only modern browsers, i.e. the latest versions of Google Chrome, Mozilla Firefox and Microsoft Edge, but <em>not</em> Microsoft Internet Explorer.</p></div>
<a name="Terminal-Sessions"></a>
<h5>Terminal Sessions<a href="#document-top" title="Go to top"></a></h5>
<p>Terminal sessions are used to display commands entered in a terminal, in sequence, without displaying their output.</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> %terminal%
>
> cd src
>
> ./configure
>
> make && sudo make install
</code></pre>
<p>Produces the following output:</p>
<div class="terminal"><p>cd src</p>
<p>./configure</p>
<p>make && sudo make install</p></div>
<p>If commands must be executed as a super-user, use the <span class="kwd">terminal-su</span> class instead:</p>
<p>The following HastyScribe Markdown code:</p>
<pre><code>> %terminal-su%
>
> shutdown -h now
</code></pre>
<p>Produces the following output:</p>
<div class="terminal-su"><p>shutdown -h now</p></div>
</div>
<div id="footer">
<p><span class="copy"></span> Fabio Cevasco – August 30, 2023</p>
<p><span>Powered by</span> <a href="https://h3rald.com/hastyscribe"><span class="hastyscribe"></span></a></p>
</div>
</div>
</body>
|