diff options
Diffstat (limited to 'docs/scruffy-markup.html')
| -rw-r--r-- | docs/scruffy-markup.html | 298 |
1 files changed, 0 insertions, 298 deletions
diff --git a/docs/scruffy-markup.html b/docs/scruffy-markup.html deleted file mode 100644 index c367a5b..0000000 --- a/docs/scruffy-markup.html +++ /dev/null @@ -1,298 +0,0 @@ -<!DOCTYPE html> -<head> -<meta charset="UTF-8"> - <link rel="stylesheet" type="text/css" href="style.css" /> -<meta name="author" content=" rsiddharth"> -<title> the scruffy markup</title></head> -<body> -<article> - - - -<h1> the scruffy markup </h1> - -<p> - <i>scruffy</i> is the markup that is understood by scruf. -</p> - -<p> -All <i>scruffy</i> marked up documents must have a <span class="monospace">.scruffy</span> extension --- that is how scruf comes to know that a particular file is, indeed, -a <i>scruffy</i> document. -</p> - -<p> -The following sections will get you acquainted with the <i>scruffy</i> -markup. -</p> - -<h2> meta things </h2> - -<p> -First things first. At the beginning of the <i>scruffy</i> document, it -is required to specify some <span class="monospace">meta</span> things -- the document title & the -author of the document. -</p> - -<p> -This is how it is done. -</p> - -<div class="code"><br />meta-title: Title of Your Document<br />meta-author: Author<br /></div> - -<h2> document date </h2> - -<p> -To specify the date of creation of the document, surround the date -with a pair of <span class="monospace">$$$</span>. -</p> - -<div class="code"><br />$$$ 1 January, 1984 $$$<br /></div> - -<p> -It can be made verbose too. -</p> - -<div class="code"><br />$$$ Posted on 1 January, 1984 $$$<br /></div> - - -<h2> headings </h2> - -<p> -The mark-up for specifying the heading is the clumsiest of all. Now is -the time to hate <i>scruffy</i> for what it is. -</p> - -<p> -To specify a <h1> heading, surround the <i>heading string</i> with a pair -of <span class="monospace">10</span> equals sign(<span class="monospace">=</span>). -</p> - -<div class="code"><br />==========<br />Heading 1<br />==========<br /></div> - -<p> -For a <h2> heading, the <i>heading string</i> is surrounded by a pair of -<span class="monospace">20</span> equals sign. -</p> - -<div class="code"><br />====================<br />Heading 2<br />====================<br /></div> - -<p> -So the math is: -</p> - -<div class="code"><br />no of equals signs = ((heading size) * 10)<br /></div> - -<p> -For <h3> (head size is 3), the number of equals signs is equal to -30. Therefore, a to get a <h3> heading, the <i>heading string</i> should -be surrounded by a pair of <span class="monospace">30</span> equals signs. -</p> - -<h2> paragraphs </h2> - -<p> -Paragraphs are delimited by a blank line. -</p> - -<div class="code"><br />foo is good at drinking.<br /><br />bar loves to hack code.<br /></div> - -<p> -The above two lines are converted to: -</p> - -<div class="code"><br /><p> foo is good at drinking.</p><br /><br /><p> bar loves to hack code.</p><br /></div> - -<h2> word decoration </h2> - -<p> - <b>Bold</b> text is surrounded by three singles quotes(<span class="monospace">'''</span>). -</p> - -<div class="code"><br />'''This text will be in bold''' <br /></div> - - -<p> - <i>Italic</i> text is surrounded by two single quotes(<span class="monospace">''</span>). -</p> - -<div class="code"><br />''This text will be italicized''<br /></div> - -<p> - <u>Underlined</u> text is surrounded by two underscores (<span class="monospace">__</span>). -</p> - -<div class="code"><br /> __This text will be underlined__<br /></div> - -<p> -Text may be <span class="monospace">monopspaced</span> too, it is done by surrounding the text with -<span class="monospace">`</span> symbol. -</p> - -<div class="code"><br /> `monospaced text` <br /></div> - -<p> -If the beginning of the text, in a paragraph, is decorated, -then, please remember to <i>leave a space before starting the -paragraph</i>. -</p> - -<div class="code"><br /> ''This paragraph is'' decorated at the beginning with italics, <br />so, a space is left before starting the paragraph.<br /></div> - -<h2> code blocks </h2> - -<p> -When it is desired to illustrate code or show verbatim text, the text -or code is put around a pair of <span class="monospace">###</span>. -</p> - -<div class="code"><br /> ###<br /><br /> #include <beer.h><br /><br /> void main() {<br /> beer lager;<br /> lager.drink();<br /> return;<br /> }<br /><br /> ###<br /></div> - -<p> -Text inside code blocks <u>cannot</u> be marked up, as all special -characters are converted into their corresponding HTML number inside a -code block. -</p> - -<p> -All through this document, those grayscaled blocks of text are, -indeed, code blocks. -</p> - -<h2> block quote </h2> - -<p> -A block of text is <i>blockquoted</i> when it is surrounded by <span class="monospace">%%%</span> -string. -</p> - -<div class="code"><br />%%%<br /><br />The is phrase is fain to be blockquoted by scruf. <br /><br />%%%<br /></div> - -<h2> links </h2> - -<p> -The markup for links is very similar to -<a href="http://moinmo.in/HelpOnMoinWikiSyntax#Hyperlinks">MoinMoin's markup -for links</a>: -</p> - -<div class="code"><br /> [[http://en.wikipedia.org/wiki/Special:Random|Wikipedia Random Article]]<br /></div> - -<p> -As seen above, the <i>link block</i> is surround by <span class="monospace">[[</span> & <span class="monospace">]]</span>. The -first part inside the link block is the <i>link</i> and the second part -(which is optional) is a description of the link. The two parts of the -<i>link block</i> is separated by a <span class="monospace">|</span> (pipe) symbol. -</p> - -<p> -The pipe symbol (<span class="monospace">|</span>) is eliminated from the <i>link block</i>, if the -link description is not specified. -</p> - -<p> -The HTML form of the above <i>link block</i> will look like: -</p> - -<div class="code"><br /><a href="http://en.wikipedia.org/wiki/Special:Random"> Wikipedia Random Article </a><br /></div> - -<h2> images </h2> - -<p> -The markup for the <i>image block</i> looks like this: -</p> - -<div class="code"><br />{{/path/to/the/image.jpg|description of the image}}<br /></div> - -<p> -As seen above, the <i>image block</i> is enclosed with <span class="monospace">{{</span> & <span class="monospace">}}</span>. The -first part of the <i>image block</i> is the path to the location where -the image stored. The second part (which is optional) is a textual -description of the image. The textual description is what that is -shown when the image cannot be displayed in the browser(text-only -browsers, for instance). -</p> - -<p> -The two parts of the <i>image block</i> is separated by the <span class="monospace">|</span> (pipe) -symbol. The pipe symbol is eliminated, if the textual description of -the image is not specified. -</p> - -<h2> audio </h2> - -<p> -scruf uses HTML5 <audio> tag to embed audio. -</p> - -<p> -The markup for embedding audio: -</p> - -<div class="code"><br />{{audio:/path/to/the/audio.ogg}}<br /></div> - -<p> -As seen above, the <i>audio block</i> is enclosed with <span class="monospace">{{</span> & -<span class="monospace">}}</span>. Inside the braces, the <i>audio block</i> starts with <span class="monospace">audio:</span> -followed by the path to the audio file. -</p> - -<p> -At present, there is support for only Ogg Vorbis audio. -</p> - -<h2> footer </h2> - -<p> -The author's name and copyright information may be placed inside the -<i>footer block</i>. This block, as the name implies, is put at the end -of the document. -</p> - -<div class="code"><br />----------------------------------------------------------------------<br />written by Audacius Scrooge. It is licensed under CC-BY-SA<br />----------------------------------------------------------------------<br /></div> - -<p> -The <i>footer block</i> is enclosed by a pair of seventy hyphens -(<span class="monospace">-</span>). -</p> - -<p> -In Emacs, the whopping seventy hyphens can be generated with a <span class="monospace">C-u 70 --</span>. -</p> - -<h2> have problems? </h2> - -<p> -If there are/is any issue(s) with understanding the <i>scruffy</i> -markup. Please subscribe & send an email to the -<a href="http://lists.nongnu.org/mailman/listinfo/scruf-friends">scruf-friends</a> -mailing list. That way we can solve your problem together. -</p> - -<p> -go back to the <a href="./scruf-howto.html">scruf-howto</a>. -</p> - - -<footer>a <i>scruffy</i> markup.</footer> - - - <div class="source"> - - <a href="./scruffy-markup.scruffy">source</a> - </div> -<div class="back"> -<a href="./"> back </a> -</div> -</article> - -<div class="lastupdate"> - Last Updated on: 21 December, 2012</div> - -<div class="scruf"> -<a href="http://nongnu.org/scruf/">powered by scruf</a> -</div> - -</body> -</html> |