added news
authorJean-Philippe Orsini <jeanfi@gmail.com>
Mon, 11 Jul 2016 18:36:50 +0000 (20:36 +0200)
committerJean-Philippe Orsini <jeanfi@gmail.com>
Mon, 11 Jul 2016 18:36:50 +0000 (20:36 +0200)
src/news/asciidoctor_to_rss.adoc
www/news/asciidoctor_to_rss.html
www/news/feed.xml
www/news/news.html

index b3b11bc..8fc8233 100644 (file)
@@ -2,3 +2,70 @@
 Jean-Philippe Orsini <jeanfi@gmail.com>
 :date: 2016-11-07
 :icons: font
+
+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.
+
+== Installation of asciidoctor_to_rss
+
+It is required to install:
+
+* maven
+
+* java (>1.7)
+
+The sources can be retrieved from GIT:
+
+----
+git clone git clone https://git.wpitchoune.net/asciidoctor_to_rss.git
+----
+
+Compilation:
+
+----
+cd asciidoctor_to_rss
+mvn clean install
+----
+
+== Howto write news
+
+Each news has to be written in a separate Asciidoctor document
+and all documents must be dropped into a directory.
+
+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.
+
+You can see some examples at https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD .
+The source document of this news is at https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD
+
+== Configuration
+
+The configuration of the utility can be done in text file.
+
+See an example at https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD .
+
+== Run the utility
+
+The command line usage is:
+
+----
+asciidoctor_to_rss.sh <IN_DIR> <OUT_DIR> <CFG_FILE>
+----
+
+`IN_DIR`: the directory containing the news as Asciidoctor documents.
+
+`OUT_DIR`: the output directory which contains all generated files
+
+`CFG_FILE`: the path to the configuration file
+
+The `OUT_DIR` will contain:
+
+* one HTML file for each Asciidoctor document
+
+* the `news.html` file
+
+* the `feed.xml` file which is a feed compatible with RSS v2.0.
index 6378a86..2ef9441 100644 (file)
 <div id='header'>
 <h1>Asciidoctor to RSS</h1>
 </div><div id='content'>
-<div class='date'>2016-11-07</div></div></body>
+<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></body>
 </html>
\ No newline at end of file
index 74c6d67..90183ef 100644 (file)
@@ -7,7 +7,103 @@
     <item>\r
       <title>Asciidoctor to RSS</title>\r
       <link>http://wpitchoune.net/news/asciidoctor_to_rss.html</link>\r
-      <description />\r
+      <description>&lt;div id="preamble"&gt;\r
+&lt;div class="sectionbody"&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;In order to have a website based only on Asciidoctor\r
+documents, I have written a small utility which\r
+converts a set of Asciidoctor documents to HTML pages and\r
+generates a RSS 2.0 feed.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;div class="sect1"&gt;\r
+&lt;h2 id="_installation_of_asciidoctor_to_rss"&gt;Installation of asciidoctor_to_rss&lt;/h2&gt;\r
+&lt;div class="sectionbody"&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;It is required to install:&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="ulist"&gt;\r
+&lt;ul&gt;\r
+&lt;li&gt;\r
+&lt;p&gt;maven&lt;/p&gt;\r
+&lt;/li&gt;\r
+&lt;li&gt;\r
+&lt;p&gt;java (&amp;gt;1.7)&lt;/p&gt;\r
+&lt;/li&gt;\r
+&lt;/ul&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;The sources can be retrieved from GIT:&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="listingblock"&gt;\r
+&lt;div class="content"&gt;\r
+&lt;pre&gt;git clone git clone https://git.wpitchoune.net/asciidoctor_to_rss.git&lt;/pre&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;Compilation:&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="listingblock"&gt;\r
+&lt;div class="content"&gt;\r
+&lt;pre&gt;cd asciidoctor_to_rss\r
+mvn clean install&lt;/pre&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;div class="sect1"&gt;\r
+&lt;h2 id="_howto_write_news"&gt;Howto write news&lt;/h2&gt;\r
+&lt;div class="sectionbody"&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;Each news has to be written in a separate Asciidoctor document\r
+and all documents must be dropped into a directory.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;There is not any restriction concerning the syntax because\r
+the utility is based on the java bridge of Asciidoctor.\r
+I have added an attribute 'date' which allows the utility\r
+to know the publication date of the news.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;You can see some examples at &lt;a href="https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD" class="bare"&gt;https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD&lt;/a&gt; .\r
+The source document of this news is at &lt;a href="https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD" class="bare"&gt;https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD&lt;/a&gt;&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;div class="sect1"&gt;\r
+&lt;h2 id="_configuration"&gt;Configuration&lt;/h2&gt;\r
+&lt;div class="sectionbody"&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;The configuration of the utility can be done in text file.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;See an example at &lt;a href="https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD" class="bare"&gt;https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD&lt;/a&gt; .&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;div class="sect1"&gt;\r
+&lt;h2 id="_run_the_utility"&gt;Run the utility&lt;/h2&gt;\r
+&lt;div class="sectionbody"&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;The command line usage is:&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="listingblock"&gt;\r
+&lt;div class="content"&gt;\r
+&lt;pre&gt;asciidoctor_to_rss.sh &amp;lt;IN_DIR&amp;gt; &amp;lt;OUT_DIR&amp;gt; &amp;lt;CFG_FILE&amp;gt;&lt;/pre&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;&lt;code&gt;IN_DIR&lt;/code&gt;:&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;&lt;code&gt;OUT_DIR&lt;/code&gt;:&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;&lt;code&gt;CFG_FILE&lt;/code&gt;:&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;</description>\r
       <pubDate>Sun, 10 Jul 2016 22:00:00 GMT</pubDate>\r
       <guid isPermaLink="false">http://wpitchoune.net/news/asciidoctor_to_rss.html</guid>\r
       <dc:date>2016-07-10T22:00:00Z</dc:date>\r
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