regenerated

[www.git] / www / news / feed.xml

diff --git a/www/news/feed.xml b/www/news/feed.xml
index c935850..6e355c1 100644 (file)
--- a/www/news/feed.xml
+++ b/www/news/feed.xml
@@ -52,10 +52,14 @@ from the GIT repository: <a href="https://git.wpitchoune.net/asciidoctor_to_r
       <description>&lt;div id="preamble"&gt;\r
 &lt;div class="sectionbody"&gt;\r
 &lt;div class="paragraph"&gt;\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;p&gt;In order to ease the edition of this website and\r
+the management of the server, I want it to be purely\r
+static and generated from &lt;a href="http://asciidoctor.org"&gt;Asciidoctor&lt;/a&gt; documents.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;The &lt;em&gt;news&lt;/em&gt; part of the website is also written as Asciidoctor\r
+documents, &lt;code&gt;asciidoctor_to_rss&lt;/code&gt; is converting them into static\r
+HTML pages and generates a RSS 2.0 file.&lt;/p&gt;\r

 &lt;/div&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r


@@ -68,10 +72,10 @@ generates a RSS 2.0 feed.&lt;/p&gt;
 &lt;div class="ulist"&gt;\r
 &lt;ul&gt;\r
 &lt;li&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;p&gt;&lt;a href="http://maven.apache.org/download.cgi"&gt;Apache Maven&lt;/a&gt; (3.3.9)&lt;/p&gt;\r

 &lt;/li&gt;\r
 &lt;li&gt;\r
 &lt;/li&gt;\r
 &lt;li&gt;\r

-&lt;p&gt;java (&amp;gt;1.7)&lt;/p&gt;\r
+&lt;p&gt;&lt;a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html"&gt;Java&lt;/a&gt; (Sun JDK &amp;gt;=1.8)&lt;/p&gt;\r

 &lt;/li&gt;\r
 &lt;/ul&gt;\r
 &lt;/div&gt;\r
 &lt;/li&gt;\r
 &lt;/ul&gt;\r
 &lt;/div&gt;\r


@@ -98,18 +102,47 @@ mvn clean install&lt;/pre&gt;
 &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;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
+&lt;p&gt;Each &lt;em&gt;news&lt;/em&gt; must be written in an &lt;a href="http://asciidoctor.org"&gt;Asciidoctor&lt;/a&gt; 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
 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
+the utility is based on the Java bridge of Asciidoctor.\r
+I have added an attribute &lt;code&gt;date&lt;/code&gt; 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
 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;p&gt;Here is an example of &lt;em&gt;news&lt;/em&gt;:&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="listingblock"&gt;\r
+&lt;div class="content"&gt;\r
+&lt;pre class="highlight"&gt;&lt;code class="language-asciidoc" data-lang="asciidoc"&gt;= Asciidoctor to RSS\r
+Jean-Philippe Orsini &amp;lt;jeanfi@gmail.com&amp;gt;\r
+:date: 2016-11-07\r
+:icons: font\r
+\r
+In order to ease the edition of this website and\r
+the management of the server, I want it to be purely\r
+static and generated from http://asciidoctor.org[Asciidoctor] documents.\r
+\r
+The _news_ part of the website is also written as Asciidoctor\r
+documents, `asciidoctor_to_rss` is converting them into static\r
+HTML pages and generates a RSS 2.0 file.\r
+\r
+== Installation of asciidoctor_to_rss\r
+\r
+It is required to install:\r
+\r
+* http://maven.apache.org/download.cgi[Apache Maven] (3.3.9)\r
+\r
+* http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java] (Sun JDK &amp;gt;=1.8)&lt;/code&gt;&lt;/pre&gt;\r
+&lt;/div&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;You can see few examples at\r
+&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 &lt;em&gt;news&lt;/em&gt; is at\r
+&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&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r


@@ -117,10 +150,37 @@ The source document of this news is at &lt;a href="https://wpitchoune.net/gitweb
 &lt;h2 id="_configuration"&gt;Configuration&lt;/h2&gt;\r
 &lt;div class="sectionbody"&gt;\r
 &lt;div class="paragraph"&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;p&gt;The configuration file of &lt;code&gt;asciidoctor_to_rss&lt;/code&gt; is text file containing key/value pairs.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;See an example at\r
+&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 class="listingblock"&gt;\r
+&lt;div class="content"&gt;\r
+&lt;pre class="highlight"&gt;&lt;code class="language-text" data-lang="text"&gt;feed.title=News\r
+feed.description=News of the wpitchoune.net website.\r
+feed.link=https://wpitchoune.net/news/feed.xml\r
+feed.baseurl=https://wpitchoune.net/news\r
+\r
+html.header.file=src/header.html&lt;/code&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;feed.title&lt;/code&gt;: the title used for the feed, in the RSS 2.0 and &lt;code&gt;news.html&lt;/code&gt; files.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;&lt;code&gt;feed.description&lt;/code&gt;: the description used in the RSS 2.0 file.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;&lt;code&gt;feed.link&lt;/code&gt;: URI of the RSS 2.0 file.&lt;/p&gt;\r
+&lt;/div&gt;\r
+&lt;div class="paragraph"&gt;\r
+&lt;p&gt;&lt;code&gt;feed.baseurl&lt;/code&gt;: base URI where the HTML news files will be located.&lt;/p&gt;\r

 &lt;/div&gt;\r
 &lt;div class="paragraph"&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;p&gt;&lt;code&gt;html.header.file&lt;/code&gt;: the content of the denoted file will be added in the &lt;code&gt;head&lt;/code&gt; block of\r
+the generated HTML documents.&lt;/p&gt;\r

 &lt;/div&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r
 &lt;/div&gt;\r


@@ -139,10 +199,10 @@ The source document of this news is at &lt;a href="https://wpitchoune.net/gitweb
 &lt;p&gt;&lt;code&gt;IN_DIR&lt;/code&gt;: the directory containing the news as Asciidoctor documents.&lt;/p&gt;\r
 &lt;/div&gt;\r
 &lt;div class="paragraph"&gt;\r
 &lt;p&gt;&lt;code&gt;IN_DIR&lt;/code&gt;: the directory containing the news as Asciidoctor documents.&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;: the output directory which contains all generated files&lt;/p&gt;\r
+&lt;p&gt;&lt;code&gt;OUT_DIR&lt;/code&gt;: the output directory which contains all generated files.&lt;/p&gt;\r

 &lt;/div&gt;\r
 &lt;div class="paragraph"&gt;\r
 &lt;/div&gt;\r
 &lt;div class="paragraph"&gt;\r

-&lt;p&gt;&lt;code&gt;CFG_FILE&lt;/code&gt;: the path to the configuration file&lt;/p&gt;\r
+&lt;p&gt;&lt;code&gt;CFG_FILE&lt;/code&gt;: the path to the configuration file.&lt;/p&gt;\r

 &lt;/div&gt;\r
 &lt;div class="paragraph"&gt;\r
 &lt;p&gt;The &lt;code&gt;OUT_DIR&lt;/code&gt; will contain:&lt;/p&gt;\r
 &lt;/div&gt;\r
 &lt;div class="paragraph"&gt;\r
 &lt;p&gt;The &lt;code&gt;OUT_DIR&lt;/code&gt; will contain:&lt;/p&gt;\r


@@ -150,13 +210,14 @@ The source document of this news is at &lt;a href="https://wpitchoune.net/gitweb
 &lt;div class="ulist"&gt;\r
 &lt;ul&gt;\r
 &lt;li&gt;\r
 &lt;div class="ulist"&gt;\r
 &lt;ul&gt;\r
 &lt;li&gt;\r

-&lt;p&gt;one HTML file for each Asciidoctor document&lt;/p&gt;\r
+&lt;p&gt;one HTML file for each Asciidoctor document,&lt;/p&gt;\r

 &lt;/li&gt;\r
 &lt;li&gt;\r
 &lt;/li&gt;\r
 &lt;li&gt;\r

-&lt;p&gt;the &lt;code&gt;news.html&lt;/code&gt; file&lt;/p&gt;\r
+&lt;p&gt;the &lt;a href="https://wpitchoune.net/news/news.html"&gt;&lt;code&gt;news.html&lt;/code&gt;&lt;/a&gt; file,&lt;/p&gt;\r

 &lt;/li&gt;\r
 &lt;li&gt;\r
 &lt;/li&gt;\r
 &lt;li&gt;\r

-&lt;p&gt;the &lt;code&gt;feed.xml&lt;/code&gt; file which is a feed compatible with RSS v2.0.&lt;/p&gt;\r
+&lt;p&gt;and the &lt;a href="https://wpitchoune.net/news/news.html"&gt;&lt;code&gt;feed.xml&lt;/code&gt;&lt;/a&gt; file which is a feed\r
+compatible with RSS v2.0.&lt;/p&gt;\r

 &lt;/li&gt;\r
 &lt;/ul&gt;\r
 &lt;/div&gt;\r
 &lt;/li&gt;\r
 &lt;/ul&gt;\r
 &lt;/div&gt;\r