diff options
44 files changed, 219 insertions, 973 deletions
diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..8b2cc5d --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,22 @@ +SCRUF - CHANGELOG +================= + +This file contains information about the changes made in different +versions of scruf. + +scruf v0.1.1 +============= + +* <pre> element is used to wrap code blocks. + +* SVG images can now be included in the scruffy markup. + +* Regex in parsers/QuoteSpecialText.java was changed to accomadate all + HTML codes. + +* Bunch of changes to the stylesheet. + +scruf v0.1.0 +============ + +* First public version of scruf.
\ No newline at end of file diff --git a/Initialization.java b/Initialization.java index 347ba07..d33e52f 100644 --- a/Initialization.java +++ b/Initialization.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..a112c7f --- /dev/null +++ b/MANIFEST @@ -0,0 +1,62 @@ +Overview of the scruf source +============================ + +This section is for folks who wish to read/explore/hack/study/etc the +source code. + +* Run.java : This is entry point for scruf. It contains the `main' + function starts the nuts & bolts of scruf. + +* parser/ : This directory contains all the `Parsers' and + related classes. + + The 'Parser' interface is defined in Parser.java and all parsers + implement this interface. + + The functionality of a Parser is to convert a specific scruffy + markup into corresponding HTML5 element. For instance, the `Link' + parser converts scruffy marked up links into corresponding HTML5 + links; The `CodeBlocks' parsers looks for code blocks in the marked up + file and converts the block into a HTML5 code block. + + `ParserList' class contains a list of all parsers that is used to + convert a scruffy markup file to valid HTML5. + +* conversion/ : Contains classes responsible for traversing + directories looking for scruffy marked up files & feeding the marked + up files to a list of parsers to convert into HTML5 + + `ConvertDirectory' class recursively traverses a directories & when + it finds a scruffy marked up file, it gives it to the `ConvertFile' + class to perform HTML5 conversion. + + `ConvertFile' gets a scruffy marked up file and feeds the file to a + list of parsers to convert to HTML5 and writes the converted HTML5 + file to the disk. + + + ignore/ : This directory contains a class which help identify + sub-directories that are to be ignored. + +* index/ : Contains the `IndexCreator' class which adds links to newly + converted HTML5 files to the directory's `index.scruffy' file + + `index.scruffy' is created in directories that have scruffy marked + up files and it contains a list of links to all the HTML5 files + converted by scruf. + +* io/ : Contains classes for reading/writing files. + +* status/ : Contains the `PresentFile' class which has the details + about the marked up file that is being converted to HTML5. + + The `DirectoryInfo' class has the `level' of the directory being + traversed with respect to the `root' directory. + + The `root' directory is the top level directory given by the user to + perform HTML5 conversion. + +* styling/ : This directory contains the StyleChecker class which + makes sure that every directory, that has a scruffy marked up file, + contains a dedicated style sheet -- style.css. + + The style.css is the default style sheet used by scruf. @@ -1,146 +1,26 @@ -scruf +scruf <http://nongnu.org/scruf/> ===== scruf is a simple program that converts marked up files to corresponding valid HTML5 files. -The markup that is understood by scruf is called the "scruffy" -markup. To learn about the scruffy markup look at -manual/scruffy-markup.html file. +To learn/use scruf take a look at the documentation[1]. -To get the up to date information about scruf, visit its homepage[1]. +See the MANIFEST, to get acquainted with the code base. + +[1]: <http://nongnu.org/scruf/manual/> -[1]: http://nongnu.org/scruf/ License ======= -scruf is free software[2] and it is licensed under the GNU General -Public License version 3 or later. - -The COPYING file contains the full text of the GNU General Public -License version 3. - -[2]: http://www.gnu.org/philosophy/free-sw.html - -The style sheet, style.css, in styling/ is dedicated to the public -domain. - -Platform -======== - -At present scruf can be used in GNU/Linux based operating -systems. Since scruf is written in Java, it might work on other -platforms like Windows, Mac, etc. - -scruf was not test in platforms other than GNU/Linux, so it might not -work as it should in platforms other than GNU/Linux, even if it -compiles successfully. - -Dependencies -============ - -To compile and run scruf, the OpenJDK[3] is need. Instructions are -provided in manual/scruf-howto.html on how to install the JDK. - -[3]: http://openjdk.java.net - -Installation -============ - -The source has to be compiled with the `javac' command, with that, the -installation is done. For instruction on compiling the scruf source, -see manual/scruf-howto.html. - -Overview of the scruf source -============================ - -This section is for folks who wish to read/explore/hack/study/etc the -source code. - -* Run.java : This is entry point for scruf. It contains the `main' - function starts the nuts & bolts of scruf. - -* parser/ : This directory contains all the `Parsers' and - related classes. - - The 'Parser' interface is defined in Parser.java and all parsers - implement this interface. - - The functionality of a Parser is to convert a specific scruffy - markup into corresponding HTML5 element. For instance, the `Link' - parser converts scruffy marked up links into corresponding HTML5 - links; The `CodeBlocks' parsers looks for code blocks in the marked up - file and converts the block into a HTML5 code block. - - `ParserList' class contains a list of all parsers that is used to - convert a scruffy markup file to valid HTML5. - -* conversion/ : Contains classes responsible for traversing - directories looking for scruffy marked up files & feeding the marked - up files to a list of parsers to convert into HTML5 +scruf is licensed under the GNU General Public License version 3 or +later, see COPYING. - `ConvertDirectory' class recursively traverses a directories & when - it finds a scruffy marked up file, it gives it to the `ConvertFile' - class to perform HTML5 conversion. +The style sheet, style.css, in styling/ is in the Public Domain. - `ConvertFile' gets a scruffy marked up file and feeds the file to a - list of parsers to convert to HTML5 and writes the converted HTML5 - file to the disk. - + ignore/ : This directory contains a class which help identify - sub-directories that are to be ignored. - -* index/ : Contains the `IndexCreator' class which adds links to newly - converted HTML5 files to the directory's `index.scruffy' file - - `index.scruffy' is created in directories that have scruffy marked - up files and it contains a list of links to all the HTML5 files - converted by scruf. - -* io/ : Contains classes for reading/writing files. - -* status/ : Contains the `PresentFile' class which has the details - about the marked up file that is being converted to HTML5. - - The `DirectoryInfo' class has the `level' of the directory being - traversed with respect to the `root' directory. - - The `root' directory is the top level directory given by the user to - perform HTML5 conversion. - -* styling/ : This directory contains the StyleChecker class which - makes sure that every directory, that has a scruffy marked up file, - contains a dedicated style sheet -- style.css. - - The style.css is the default style sheet used by scruf. - -* docs/ directory: Contains documentation on how to install and use - scruf. - -Mailing List -============ - -All public discussion regarding the scruf project happens in the -scruf-friends[4] mailing list. - -If you want help or have issues using scruf or wish to contribute to -the scruf project or desire to give vent to your thoughts about scruf, -the scruf-friends[4] list is the right place. - -[4]: https://lists.nongnu.org/mailman/listinfo/scruf-friends - -Report a Bug -============ - -Found scruf has gone bonkers or it is not working the way it has to? -Just file a bug report[5] about it. Please also provide your contact -information if it is required. - -[5]: http://savannah.nongnu.org/bugs/?group=scruf&func=additem - -Author -====== +Contact +======= -scruf is authored & maintained by rsiddharth -<rsiddharth@ninthfloor.org>.
\ No newline at end of file +rsiddharth <rsiddharth@ninthfloor.org>
\ No newline at end of file @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/conversion/CanConvert.java b/conversion/CanConvert.java index 8f704e7..636c75c 100644 --- a/conversion/CanConvert.java +++ b/conversion/CanConvert.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/conversion/ConvertDirectory.java b/conversion/ConvertDirectory.java index 9b002fe..2cbb528 100644 --- a/conversion/ConvertDirectory.java +++ b/conversion/ConvertDirectory.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/conversion/ConvertFile.java b/conversion/ConvertFile.java index f37d009..7d6f308 100644 --- a/conversion/ConvertFile.java +++ b/conversion/ConvertFile.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/conversion/CreateHtmlFile.java b/conversion/CreateHtmlFile.java index 729b3cf..f0bb8cf 100644 --- a/conversion/CreateHtmlFile.java +++ b/conversion/CreateHtmlFile.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/conversion/FileSieve.java b/conversion/FileSieve.java index 3571433..43de3b3 100644 --- a/conversion/FileSieve.java +++ b/conversion/FileSieve.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/conversion/ignore/Ignored.java b/conversion/ignore/Ignored.java index a13434e..0b43a38 100644 --- a/conversion/ignore/Ignored.java +++ b/conversion/ignore/Ignored.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/docs/scruf-howto.html b/docs/scruf-howto.html deleted file mode 100644 index 09eb543..0000000 --- a/docs/scruf-howto.html +++ /dev/null @@ -1,258 +0,0 @@ -<!DOCTYPE html> -<head> -<meta charset="UTF-8"> - <link rel="stylesheet" type="text/css" href="style.css" /> -<meta name="author" content=" rsiddharth"> -<title> scruf manual</title></head> -<body> -<article> - - - -<h1> scruf manual </h1> - -<h2> scruf </h2> - -<p> -scruf is a dirty, but minimalistic, program that spits out valid HTML5 -files from marked up plain text files. -</p> - -<h3> scruffy markup </h3> - -<p> -The markup that is understood by scruf is called <i>scruffy</i>. The -<i>scruffy</i> markup is inspired from -<a href="http://moinmo.in/HelpOnMoinWikiSyntax">MoinMoin's markup</a>. -</p> - -<p> -To learn about the syntax and details about the <i>scruffy</i> markup, -take a look at the <a href="./scruffy-markup.html">documentation page</a> of -<i>scruffy</i> markup. -</p> - -<h2> how scruf works </h2> - -<p> -The way scruf works is darn straightforward. You give it a directory -and it recursively checks for <i>scruffy</i> marked up files and converts -them into valid HTML5. -</p> - -<p> -In each directory that contains <i>scruffy</i> marked up files, scruf -automatically creates an <span class="monospace">index.scruffy</span> file and a corresponding -<span class="monospace">index.html</span>,to which it appends links to all the HTML5 files that it -has converted. -</p> - -<p> -scruf provides its own style sheet which is placed in each directory -that has HTML5 files produced by scruf. -</p> - -<h2> using scruf </h2> - -<p> -At present, scruf is cursed to only run on GNU/Linux based operating -systems. -</p> - -<p> -scruf is written in Java, therefore, there is a strong possibility -that it could work out of the box in Windows, Mac, etc. But, be aware -that it was never tested in platforms other than GNU/Linux, so there -is no assurance that it <i>will</i> work as it should on other platforms. -</p> - -<p> -To be able to use scruf, the <span class="monospace">openjdk</span> package is required, in order to -compile and run scruf. -</p> - -<h3> installing the jdk </h3> - -<p> -On a <a href="http://www.debian.org/">Debian</a> GNU/Linux based system, the JDK -can be installed with: -</p> - -<div class="code"><br /> # apt-get update<br /> # apt-get install default-jdk<br /></div> - -<p> -If the above <span class="monospace">install</span> command does not work, do: -</p> - -<div class="code"><br /> # apt-cache search jdk <br /></div> - -<p> -to find the appropriate package name for the JDK and then install the -package with: -</p> - -<div class="code"><br /> # apt-get install appropriate-package-name<br /></div> - -<p> -For installing the JDK on other GNU/Linux systems, take a look at -openjdk's <a href="http://openjdk.java.net/">homepage</a> for more information. -</p> - -<h3> compiling scruf </h3> - -<p> -You must compile scruf's source files, before it can be run to eat -your <i>scruffy</i> marked up files. -</p> - -<p> -Extract the tar archive and <span class="monospace">cd</span> to scruf's territory: -</p> - -<div class="code"><br /> $ tar -xvzf scruf-X.X.X.tar.gz<br /> $ cd scruf-X.X.X/<br /></div> - -<p> -The 'X's represent the version number of the scruf package. -</p> - -<p> -The compilation procedure is arduous at present, it will be made -simpler and nicer in the future to come. -</p> - -<p> -Here's how the source is compiled at present: -</p> - -<div class="code"><br /> $ javac scruf/*.java<br /> $ javac scruf/*/*.java<br /> $ javac scruf/*/*/*.java<br /></div> - -<p> -By now, scruf is cooked and read to be exploited by your sweet -hands. -</p> - -<h3> convert <i>scruffy</i> files to HTML5 </h3> - -<p> -To convert <i>scruffy</i> marked up files, <span class="monospace">cd</span> to the directory where -scruf is: -</p> - -<div class="code"><br /> $ cd /path/to/scruf-X.X.X/<br /></div> - -<p> -and do: -</p> - -<div class="code"><br /> $ java scruf.Run /path/to/scruffy-files-directory/<br /></div> - -<p> -scruf will convert the <i>scruffy</i> marked up files and place the -generated HTML5 files in the same directory where the <i>scruffy</i> -marked up files reside. -</p> - -<p> -The HTML5 files, generated by scruf, <u>must not</u> be manually edited, -if you wish to edit a HTML5 file, edit the corresponding <i>scruffy</i> marked -up file and generate the HTML5 files again by doing: -</p> - -<div class="code"><br /> $ java scruf.Run<br /></div> - -<p> -As is seen above, it is not required to give the path to the <i>scruffy</i> -files directory every time. scruf is intelligent enough to remember -the directory. So from the second time on, it is just enough to run -the program. -</p> - -<p> -When a directory is given to scruf, when it is invoked: -</p> - -<div class="code"><br /> $ java scruf.Run /path/to/directory<br /></div> - -<p> -It stores the absolute path of the directory in <span class="monospace">~/.scruf/list</span>. -</p> - -<p> -Every time, scruf is run: -</p> - -<div class="code"><br /> $ java scruf.Run<br /></div> - -<p> -it checks all the directories is the <span class="monospace">list</span> for new/modified <i>scruffy</i> -marked up files and converts them into HTML5. -</p> - -<h3> ignoring directories </h3> - -<p> -As previously mentioned, scruf recursively checks the given directory -to find <i>scruffy</i> marked up files. There will be times when it doesn't -make sense to let scruf loiter in sub-directories. It is possible to -tell scruf to ignore the respective sub-directories. -</p> - -<p> -To do this, create a <span class="monospace">.ignored</span> file in the respective directory and -list all the sub-directories that has to be ignored. The -sub-directories listed in <span class="monospace">.ignored</span> should be line seperated. -</p> - -<p> -For instance, if <span class="monospace">audio/</span>, <span class="monospace">video/</span>, <span class="monospace">images/</span> are the -sub-directories, that are to be ignored by scruf in the respective -directory. The <span class="monospace">.ignore</span> file, in this case, will look like this: -</p> - -<div class="code"><br />audio/<br />video/<br />images/<br /></div> - -<h2> Cascading Style Sheets(CSS) </h2> - -<p> -scruf places <span class="monospace">style.css</span> in each directory in which it finds a <i>scruffy</i> -marked up file. Feel free to edit & modify the style sheet. but please -remember not to change/remove the <u>names</u> of <span class="monospace">classes</span>, it may -mess up the formatting of all the HTML5 files that are dependent on the -style sheet. -</p> - -<p> -The <a href="./style.css">style.css</a> is valid CSS3. -</p> - -<h2> have problems? </h2> - -<p> -If there are/is any issue(s) with using scruf or understanding how it -works. 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> - - -<footer>a <i>scruffy</i> howto.</footer> - - - <div class="source"> - - <a href="./scruf-howto.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> 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> diff --git a/docs/style.css b/docs/style.css deleted file mode 100644 index d6a533a..0000000 --- a/docs/style.css +++ /dev/null @@ -1,180 +0,0 @@ -/* - Author: rsiddharth - Contact: <rsiddharth@ninthfloor.org> - License: Public Domain <http://creativecommons.org/publicdomain/zero/1.0/> - -*/ - -article { - font-size:1.50em; - font-family:"Palatino Linotype","Book Antiqua",Palatino,"URW Palladio L",FreeSerif,serif; - color:#787878; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:97%; - box-shadow: 1px 1.5px 3px 0.5px #bababa; -} - -h1, h2, h3, h4, h5 { - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:75%; - text-align:center; -} -h1 { - font-size:1.80em; -} - -p, i, b{ - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:70%; - text-align:justify; - line-height:170%; - -moz-word-wrap:break-word; -} -.center { - text-align:center; -} - -blockquote { - font-size:0.77em; - font-style:oblique; - color:#888888; - text-align:justify; - background-color:#fcfcfc; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:60%; -} - -span.monospace { - border: 1px; - padding: 1px; - font-size:0.625em; - font-family:monospace; -} - -div.code { - font-family:monospace; - font-size:0.625em; - background-color:#fcfcfc; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:70%; -} - -div.time { - font-size:0.50em; - font-family:"Palatino Linotype","Book Antiqua",Palatino,"URW Palladio L",FreeSerif,serif; - color:#aaaaaa; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:20%; - text-align:center; -} - -img { - margin-left:auto; - margin-right:auto; - display:block; - border: 1px; - padding: 10px; -} - -audio { - margin-left:auto; - margin-right:auto; - display:block; - border: 1px; - padding: 10px; -} - -a:link,a:visited { - transition:border-bottom 0.3s, color 0.3s; - -moz-transition:border-bottom 0.3s, color 0.3s; - -webkit-transition:border-bottom 0.3s, color 0.3s; - -o-transition:border-bottom 0.3s, color 0.3s; - color:#686868; - border-bottom:1px dotted #d9d9d9; - text-decoration:none; -} -a:hover,a:active { - color:#000000; - border-bottom: 1px; - text-decoration:none; -} - -div.back { - font-size:0.7em; - font-family:junicode,"Palatino Linotype","Book Antiqua",Palatino,"URW Palladio L",FreeSerif,serif; - text-align:center; - color:#989898; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:7%; -} - -footer { - font-size:0.8em; - font-family:"Palatino Linotype","Book Antiqua",Palatino,"URW Palladio L",FreeSerif,serif; - text-align:center; - color:#989898; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:45%; -} - -div.lastupdate { - font-size:0.6em; - font-family:"Palatino Linotype","Book Antiqua",Palatino,"URW Palladio L",FreeSerif,serif; - text-align:center; - color:#989898; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:40%; -} - -div.source { - font-size:0.4em; - font-family:monospace; - text-align:center; - color:#989898; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:40%; -} - -div.scruf { - font-size:0.9em; - font-family:"Palatino Linotype","Book Antiqua",Palatino,"URW Palladio L",FreeSerif,serif; - text-align:center; - color:#bcbcbc; - margin-left:auto; - margin-right:auto; - border:1px; - padding:5px; - width:40%; - -} - diff --git a/index/IndexCreator.java b/index/IndexCreator.java index f4757ae..e0e7846 100644 --- a/index/IndexCreator.java +++ b/index/IndexCreator.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/io/ReadFile.java b/io/ReadFile.java index 2607b16..ecb3978 100644 --- a/io/ReadFile.java +++ b/io/ReadFile.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/io/WriteFile.java b/io/WriteFile.java index 0a2a1e7..94fbab5 100644 --- a/io/WriteFile.java +++ b/io/WriteFile.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/license/Liberate.java b/license/Liberate.java index 22ab291..7571afe 100644 --- a/license/Liberate.java +++ b/license/Liberate.java @@ -1,6 +1,5 @@ /*+ - * Copyright (C) 2012-2013 rsiddharth - * Contact me : rsiddharth@ninthfloor.org + * Copyright (C) 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -24,36 +23,72 @@ import scruf.io.*; public class Liberate { private String gpl; - - public Liberate() { - gpl = new ReadFile(new File("./scruf/license/gpl")).getContent(); - } - + + // Used in iterate() private Pattern pattern; private Matcher matcher; - private PrintWriter writer; + + // Used in update() + private String oldString; + private String newString; - public void baptize(String directory, String regex) { - File dir = new File(directory).getAbsoluteFile(); - File[] dirContents = dir.listFiles(); - String fileContent; - pattern = pattern.compile(regex); - for(File file:dirContents) { - if(file.isFile()) { - matcher = pattern.matcher(file.getName()); - if(matcher.find()) { - fileContent = new ReadFile(file).getContent(); - gpl(file,fileContent); - } - } - else { - // is a Directory. - baptize(file.getPath(),regex); - } + // TYPES: + public static int BAPTIZE = 1, UPDATE = 2; + + // For Baptize + public Liberate(String dir, String regex, int TYPE) { + gpl = new ReadFile(new File("./scruf/license/gpl")).getContent(); + iterate(dir, regex, TYPE); + } + + // For Update + public Liberate(String dir, String regex, int TYPE, + String oldString, String newString) { + this.oldString = oldString; + this.newString = newString; + iterate(dir, regex, TYPE); } + + public void iterate(String directory, String regex, int TYPE) { + File dir = new File(directory).getAbsoluteFile(); + File[] dirContents = dir.listFiles(); + String fileContent; + pattern = pattern.compile(regex); + for(File file:dirContents) { + if(file.isFile()) { + matcher = pattern.matcher(file.getName()); + if(matcher.find()) { + fileContent = new ReadFile(file).getContent(); + if(TYPE == BAPTIZE) + baptize(file,fileContent); + else if(TYPE == UPDATE) + update(file, fileContent); + } + } + else { + // is a Directory. + iterate(file.getPath(), regex, TYPE); + } + } } + + public void update(File file, + String fileContent) { + Matcher matcher = Pattern.compile(oldString).matcher(fileContent); + if(matcher.find()) { + System.out.println("Updating "+file+"..."); + StringBuffer sbuffer = new StringBuffer(); + matcher.appendReplacement(sbuffer, newString); + matcher.appendTail(sbuffer); + // write updated content to file. + new WriteFile(file, sbuffer.toString()).write(); + }else { + System.out.println("ol' string not found in " + file); + } + } - private void gpl(File file, String fileContent) { + private void baptize(File file, + String fileContent) { Matcher matcher = Pattern.compile("^/\\*\\+").matcher(fileContent); if(!(matcher.find())) { System.out.println("Baptizing "+file+"..."); @@ -66,8 +101,21 @@ public class Liberate { } public static void main(String[] args) { - Liberate libre = new Liberate(); - libre.baptize("./scruf/",".+\\.java$"); + /* Liberate copyrightUpdate = new Liberate("./scruf/", + ".+\\.java$", + Liberate.UPDATE, + "Copyright 2012 rsiddharth", + "Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org>"); + Liberate emailDelete = new Liberate("./scruf/", + ".+\\.java$", + Liberate.UPDATE, + " \\* Email: <rsiddharth@ninthfloor.org> \n \\*", + " *");*/ + + Liberate baptize = new Liberate("./scruf/", + ".+\\.java$", + Liberate.BAPTIZE + ); } -}
\ No newline at end of file +} diff --git a/license/gpl b/license/gpl index c275824..48a3e5a 100644 --- a/license/gpl +++ b/license/gpl @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Audio.java b/parsers/Audio.java index 78d08a5..3773da9 100644 --- a/parsers/Audio.java +++ b/parsers/Audio.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/BackButton.java b/parsers/BackButton.java index 38e5a9e..7be4d95 100644 --- a/parsers/BackButton.java +++ b/parsers/BackButton.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/CloseHtmlTags.java b/parsers/CloseHtmlTags.java index ddeaf10..b9404d9 100644 --- a/parsers/CloseHtmlTags.java +++ b/parsers/CloseHtmlTags.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/CodeBlocks.java b/parsers/CodeBlocks.java index a783951..33ad4e3 100644 --- a/parsers/CodeBlocks.java +++ b/parsers/CodeBlocks.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * @@ -69,4 +68,4 @@ fizz ### -*/
\ No newline at end of file +*/ diff --git a/parsers/DocumentDate.java b/parsers/DocumentDate.java index 7b66caa..46134d7 100644 --- a/parsers/DocumentDate.java +++ b/parsers/DocumentDate.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Footer.java b/parsers/Footer.java index ad85c10..13586ec 100644 --- a/parsers/Footer.java +++ b/parsers/Footer.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Header.java b/parsers/Header.java index 88316d5..da52094 100644 --- a/parsers/Header.java +++ b/parsers/Header.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Headings.java b/parsers/Headings.java index 51f3c5b..604d359 100644 --- a/parsers/Headings.java +++ b/parsers/Headings.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Images.java b/parsers/Images.java index f38ef46..9707051 100644 --- a/parsers/Images.java +++ b/parsers/Images.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * @@ -39,10 +38,10 @@ public class Images implements Parser { replacementString.append(openTag); // if the "title" is given add to the _img_ tag. if(matcher.group(3)!=null) { - replacementString.append("4 \\] \" title=\"$4\""); + replacementString.append("4 \\]\" title=\"$4\""); } else { - replacementString.append("1\""); + replacementString.append("1 \\]\""); } // close the _img_ tag. replacementString.append(closeTag); diff --git a/parsers/LastUpdate.java b/parsers/LastUpdate.java index 4d9f168..6d14333 100644 --- a/parsers/LastUpdate.java +++ b/parsers/LastUpdate.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/LineBreak.java b/parsers/LineBreak.java index b2394d9..963f095 100644 --- a/parsers/LineBreak.java +++ b/parsers/LineBreak.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Links.java b/parsers/Links.java index 396677f..f7add30 100644 --- a/parsers/Links.java +++ b/parsers/Links.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/MetaParser.java b/parsers/MetaParser.java index 4ac9394..3e27acc 100644 --- a/parsers/MetaParser.java +++ b/parsers/MetaParser.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/NullIt.java b/parsers/NullIt.java index d13f543..f99be45 100644 --- a/parsers/NullIt.java +++ b/parsers/NullIt.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Paragraphs.java b/parsers/Paragraphs.java index 29a546a..7b21d69 100644 --- a/parsers/Paragraphs.java +++ b/parsers/Paragraphs.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Parser.java b/parsers/Parser.java index 7bddbdc..6eb9238 100644 --- a/parsers/Parser.java +++ b/parsers/Parser.java @@ -1,8 +1,9 @@ /*+ - * Copyright (C) 2012-2013 rsiddharth - * email me : rsiddharth@ninthfloor.org - * - * This program is free software: you can redistribute it and/or modify + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> + * + * This file is part of Scruf. + * + * Scruf is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. @@ -16,6 +17,7 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. */ + package scruf.parsers; public interface Parser { diff --git a/parsers/ParserList.java b/parsers/ParserList.java index 8db7a04..b155329 100644 --- a/parsers/ParserList.java +++ b/parsers/ParserList.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/QuoteSpecialText.java b/parsers/QuoteSpecialText.java index 91e8760..cf2fcd8 100644 --- a/parsers/QuoteSpecialText.java +++ b/parsers/QuoteSpecialText.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/Source.java b/parsers/Source.java index 4dbe303..1a72425 100644 --- a/parsers/Source.java +++ b/parsers/Source.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/SymbolMap.java b/parsers/SymbolMap.java index 752fcf6..ac9ab7e 100644 --- a/parsers/SymbolMap.java +++ b/parsers/SymbolMap.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/parsers/WordDecoration.java b/parsers/WordDecoration.java index e7cc0ac..38bd83b 100644 --- a/parsers/WordDecoration.java +++ b/parsers/WordDecoration.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/status/DirectoryInfo.java b/status/DirectoryInfo.java index d2cd191..f2e2f2f 100644 --- a/status/DirectoryInfo.java +++ b/status/DirectoryInfo.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/status/PresentFile.java b/status/PresentFile.java index 2e1a690..168575d 100644 --- a/status/PresentFile.java +++ b/status/PresentFile.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/styling/StyleChecker.java b/styling/StyleChecker.java index e70170a..ba25446 100644 --- a/styling/StyleChecker.java +++ b/styling/StyleChecker.java @@ -1,6 +1,5 @@ /*+ - * Copyright 2012 rsiddharth - * Email: <rsiddharth@ninthfloor.org> + * Copyright 2012, 2013 rsiddharth <rsiddharth@ninthfloor.org> * * This file is part of Scruf. * diff --git a/styling/style.css b/styling/style.css index 1f5f014..ffe1ba2 100644 --- a/styling/style.css +++ b/styling/style.css @@ -60,6 +60,9 @@ span.monospace { padding: 1px; font-size:0.625em; font-family:monospace; + background-color: #fcfcfc; + border: 1px solid #f0f0f0; + padding: 2px; } pre { |