<div class='date'>2016-11-07</div><div id="preamble">
<div class="sectionbody">
<div class="paragraph">
-<p>In order to have a website based only on Asciidoctor
-documents, I have written a small utility which
-converts a set of Asciidoctor documents to HTML pages and
-generates a RSS 2.0 feed.</p>
+<p>In order to ease the edition of this website and
+the management of the server, I want it to be purely
+static and generated from <a href="http://asciidoctor.org">Asciidoctor</a> documents.</p>
+</div>
+<div class="paragraph">
+<p>The <em>news</em> part of the website is also written as Asciidoctor
+documents, <code>asciidoctor_to_rss</code> is converting them into static
+HTML pages and generates a RSS 2.0 file.</p>
</div>
</div>
</div>
<div class="ulist">
<ul>
<li>
-<p>maven</p>
+<p><a href="http://maven.apache.org/download.cgi">Apache Maven</a> (3.3.9)</p>
</li>
<li>
-<p>java (>1.7)</p>
+<p><a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java</a> (Sun JDK >=1.8)</p>
</li>
</ul>
</div>
<h2 id="_howto_write_news">Howto write news</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Each news has to be written in a separate Asciidoctor document
+<p>Each <em>news</em> must be written in an <a href="http://asciidoctor.org">Asciidoctor</a> document
and all documents must be dropped into a directory.</p>
</div>
<div class="paragraph">
<p>There is not any restriction concerning the syntax because
-the utility is based on the java bridge of Asciidoctor.
-I have added an attribute 'date' which allows the utility
+the utility is based on the Java bridge of Asciidoctor.
+I have added an attribute <code>date</code> which allows the utility
to know the publication date of the news.</p>
</div>
<div class="paragraph">
-<p>You can see some examples at <a href="https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD</a> .
-The source document of this news is at <a href="https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD</a></p>
+<p>Here is an example of <em>news</em>:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-asciidoc" data-lang="asciidoc">= Asciidoctor to RSS
+Jean-Philippe Orsini <jeanfi@gmail.com>
+:date: 2016-11-07
+:icons: font
+
+In order to ease the edition of this website and
+the management of the server, I want it to be purely
+static and generated from http://asciidoctor.org[Asciidoctor] documents.
+
+The _news_ part of the website is also written as Asciidoctor
+documents, `asciidoctor_to_rss` is converting them into static
+HTML pages and generates a RSS 2.0 file.
+
+== Installation of asciidoctor_to_rss
+
+It is required to install:
+
+* http://maven.apache.org/download.cgi[Apache Maven] (3.3.9)
+
+* http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java] (Sun JDK >=1.8)</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>You can see few examples at
+<a href="https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD</a>.
+The source document of this <em>news</em> is at
+<a href="https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD</a>.</p>
</div>
</div>
</div>
<h2 id="_configuration">Configuration</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>The configuration of the utility can be done in text file.</p>
+<p>The configuration file of <code>asciidoctor_to_rss</code> is text file containing key/value pairs.</p>
+</div>
+<div class="paragraph">
+<p>See an example at
+<a href="https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD</a> .</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-text" data-lang="text">feed.title=News
+feed.description=News of the wpitchoune.net website.
+feed.link=https://wpitchoune.net/news/feed.xml
+feed.baseurl=https://wpitchoune.net/news
+
+html.header.file=src/header.html</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p><code>feed.title</code>: the title used for the feed, in the RSS 2.0 and <code>news.html</code> files.</p>
+</div>
+<div class="paragraph">
+<p><code>feed.description</code>: the description used in the RSS 2.0 file.</p>
+</div>
+<div class="paragraph">
+<p><code>feed.link</code>: URI of the RSS 2.0 file.</p>
+</div>
+<div class="paragraph">
+<p><code>feed.baseurl</code>: base URI where the HTML news files will be located.</p>
</div>
<div class="paragraph">
-<p>See an example at <a href="https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD" class="bare">https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD</a> .</p>
+<p><code>html.header.file</code>: the content of the denoted file will be added in the <code>head</code> block of
+the generated HTML documents.</p>
</div>
</div>
</div>
<p><code>IN_DIR</code>: the directory containing the news as Asciidoctor documents.</p>
</div>
<div class="paragraph">
-<p><code>OUT_DIR</code>: the output directory which contains all generated files</p>
+<p><code>OUT_DIR</code>: the output directory which contains all generated files.</p>
</div>
<div class="paragraph">
-<p><code>CFG_FILE</code>: the path to the configuration file</p>
+<p><code>CFG_FILE</code>: the path to the configuration file.</p>
</div>
<div class="paragraph">
<p>The <code>OUT_DIR</code> will contain:</p>
<div class="ulist">
<ul>
<li>
-<p>one HTML file for each Asciidoctor document</p>
+<p>one HTML file for each Asciidoctor document,</p>
</li>
<li>
-<p>the <code>news.html</code> file</p>
+<p>the <a href="https://wpitchoune.net/news/news.html"><code>news.html</code></a> file,</p>
</li>
<li>
-<p>the <code>feed.xml</code> file which is a feed compatible with RSS v2.0.</p>
+<p>and the <a href="https://wpitchoune.net/news/news.html"><code>feed.xml</code></a> file which is a feed
+compatible with RSS v2.0.</p>
</li>
</ul>
</div>
projects / www.git / blobdiff