X-Git-Url: https://wpitchoune.net/gitweb/?a=blobdiff_plain;f=www%2Fnews%2Ffeed.xml;h=c84e42c0d5687b5a379475d6d50d774800fd8fd0;hb=2dd558f5533166a85045f581b042dd539505ecce;hp=74c6d6720c161ac6b1d417011a89d5f6afc07178;hpb=7ad4278575f413699b6d754ba7cf04cca9cd397c;p=www.git diff --git a/www/news/feed.xml b/www/news/feed.xml index 74c6d67..c84e42c 100644 --- a/www/news/feed.xml +++ b/www/news/feed.xml @@ -7,7 +7,119 @@ Asciidoctor to RSS http://wpitchoune.net/news/asciidoctor_to_rss.html - + <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>: 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> +</div> +<div class="paragraph"> +<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> +<div class="ulist"> +<ul> +<li> +<p>one HTML file for each Asciidoctor document</p> +</li> +<li> +<p>the <code>news.html</code> file</p> +</li> +<li> +<p>the <code>feed.xml</code> file which is a feed compatible with RSS v2.0.</p> +</li> +</ul> +</div> +</div> +</div> Sun, 10 Jul 2016 22:00:00 GMT http://wpitchoune.net/news/asciidoctor_to_rss.html 2016-07-10T22:00:00Z