added news
[www.git] / www / news / news.html
index 5c0a642..5285000 100644 (file)
 <h1>News</h1>
 </div><div id='content'>
 
-<div><h2><a href='http://wpitchoune.net/news/asciidoctor_to_rss.html'>Asciidoctor to RSS</a></h2><div class='date'>2016-11-07</div></div>
+<div><h2><a href='http://wpitchoune.net/news/asciidoctor_to_rss.html'>Asciidoctor to RSS</a></h2><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>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_installation_of_asciidoctor_to_rss">Installation of asciidoctor_to_rss</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>It is required to install:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>maven</p>
+</li>
+<li>
+<p>java (&gt;1.7)</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>The sources can be retrieved from GIT:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>git clone git clone https://git.wpitchoune.net/asciidoctor_to_rss.git</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Compilation:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>cd asciidoctor_to_rss
+mvn clean install</pre>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<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
+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
+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>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_configuration">Configuration</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The configuration of the utility can be done in text file.</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>
+</div>
+<div class="sect1">
+<h2 id="_run_the_utility">Run the utility</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The command line usage is:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>asciidoctor_to_rss.sh &lt;IN_DIR&gt; &lt;OUT_DIR&gt; &lt;CFG_FILE&gt;</pre>
+</div>
+</div>
+<div class="paragraph">
+<p><code>IN_DIR</code>:</p>
+</div>
+<div class="paragraph">
+<p><code>OUT_DIR</code>:</p>
+</div>
+<div class="paragraph">
+<p><code>CFG_FILE</code>:</p>
+</div>
+</div>
+</div></div>
 
 <div><h2><a href='http://wpitchoune.net/news/added_rss_feed.html'>RSS Feed</a></h2><div class='date'>2016-04-07</div><div class="paragraph">
 <p>It is now possible to follow news and announces of the