summaryrefslogtreecommitdiffstats
path: root/docs/scruf
blob: 63f0b3ebc5185ca1185d8e63305254102d0433e8 (plain) (blame)
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
scruf - documentation

==========
scruf - documentation
==========

 ''scruf'' is a simple program that converts text marked-up in
''scruffy'' mark-up to HTML5 files. It was written specifically for
generating blog posts. The way ''scruf'' works is straight forward --
it takes in directory and converts all the ''scruffy'' marked-up
plain-text files into corresponding HTML5 files. After the conversion,
''scruf'' puts links to the generated HTML5 files in the `index.html`
file of that directory. So, that's how ''scruf'' works.

====================
using scruf
====================

Before you plunge into learning about scruf and eventually using
it. Let me run you through the pre-requisites.

 '''Paraphernalia''': ''scruf'' is written in Java, therefore, you'll
 need the `openjdk` package, inorder to be able to compile and run
 scruf. Go ahead and install `openjdk` before proceeding
 forward. Number two, ''scruf'' was written on a GNU/Linux machine,
 so, it should work well on all Unix-based operating systems.

Once, you have a copy of `openjdk` installed on your machine, you're
all set to start licking ''scruf''. Here we go.  

==============================
scruffy mark-up
==============================

Inorder to convert plain-text files into HTML5 using ''scruf'', you
got to mark it up with the ''scruff'' mark-up, so that ''scruf''
understands the elements of the plain-text document and duly converts
them into HTML5. As the name suggests ''scruffy'' mark is pretty
shabby when compared to cleaner mark-ups like
[[http://daringfireball.net/projects/markdown/|Markdown]]. ''scruffy''
is inspired, to an extent, from [[http://moinmo.in/|MoinMoin]] &
[[http://www.mediawiki.org/wiki/MediaWiki|MediaWiki]] syntax.


========================================
basic structure
========================================

The ''scruffy'' plain-text document that is going to be converted by
''scruf'', follows a format and here it is: 

###

title

==========
foo heading
==========

$$$ 1 January 1970 $$$

The bar blog post goes like this...
...
...
the bar blog post ends

----------------------------------------------------------------------
author's signature
----------------------------------------------------------------------

###

The first line in the ''scruffy'' document __must__ always begin with
the text of the title of the document. The ''title'' is the string
that is going to be displayed on the browser tabs and for compliance
sake, it is recommended that it be same as the ''heading'' of the
''scruffy'' document. Followed by the ''title'' is the heading, then
the body of the post/essay/whatever and finally the author's
signature. This is the basic structure of a ''scruffy'' document.


========================================
syntax
========================================

==============================
running scruf
==============================