added
[www.git] / www / news / feed.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <rss xmlns:dc="http://purl.org/dc/elements/1.1/" version="2.0">\r
3   <channel>\r
4     <title>News</title>\r
5     <link>https://wpitchoune.net/news/feed.xml</link>\r
6     <description>News of the wpitchoune.net website.</description>\r
7     <item>\r
8       <title>New website</title>\r
9       <link>https://wpitchoune.net/news/new_website.html</link>\r
10       <description>&lt;div class="paragraph"&gt;\r
11 &lt;p&gt;After being bored with Wordpress for years, the &lt;a href="http://wpitchoune.net"&gt;wpitchoune.net&lt;/a&gt;\r
12 website is changing. It is now based on &lt;a href="http://asciidoctor.org"&gt;Asciidoctor&lt;/a&gt; and\r
13 a simple shell script to generate it.&lt;/p&gt;\r
14 &lt;/div&gt;\r
15 &lt;div class="paragraph"&gt;\r
16 &lt;p&gt;With the help of &lt;a href="http://atom.io"&gt;Atom&lt;/a&gt; and a couple of addons dedicated to\r
17 Asciidoctor, it is easy and quick to write content. I am happy to no\r
18 more have to worry about the painful admistration of Wordpress,\r
19 upgrading it, taking care of security, spamming of comments and bot\r
20 account creation, and backup of databases.&lt;/p&gt;\r
21 &lt;/div&gt;\r
22 &lt;div class="paragraph"&gt;\r
23 &lt;p&gt;If you want to know how the website is built, everything is on\r
24 a GIT repository: &lt;a href="http://git.wpitchoune.net/gitweb/?p=www.git" class="bare"&gt;http://git.wpitchoune.net/gitweb/?p=www.git&lt;/a&gt;.\r
25 It is simple, really simple&amp;#8230;&amp;#8203; but enough for my needs.&lt;/p&gt;\r
26 &lt;/div&gt;</description>\r
27       <pubDate>Mon, 13 Jun 2016 22:00:00 GMT</pubDate>\r
28       <guid isPermaLink="false">https://wpitchoune.net/news/new_website.html</guid>\r
29       <dc:date>2016-06-13T22:00:00Z</dc:date>\r
30     </item>\r
31     <item>\r
32       <title>Call for contributions for the translation of psensor</title>\r
33       <link>https://wpitchoune.net/news/call_contribution.html</link>\r
34       <description>&lt;div class="paragraph"&gt;\r
35 &lt;p&gt;The version 1.2.0 of psensor is going to be released in the coming\r
36 weeks. This release will include many changes which impact the\r
37 translations. If you want to contribute to the translation of psensor\r
38 it is now the good timeframe. See the\r
39 &lt;a href="https://wpitchoune.net/psensor/contribute.html"&gt;instructions&lt;/a&gt;.&lt;/p&gt;\r
40 &lt;/div&gt;</description>\r
41       <pubDate>Mon, 13 Jun 2016 22:00:00 GMT</pubDate>\r
42       <guid isPermaLink="false">https://wpitchoune.net/news/call_contribution.html</guid>\r
43       <dc:date>2016-06-13T22:00:00Z</dc:date>\r
44     </item>\r
45     <item>\r
46       <title>RSS Feed</title>\r
47       <link>https://wpitchoune.net/news/added_rss_feed.html</link>\r
48       <description>&lt;div class="paragraph"&gt;\r
49 &lt;p&gt;It is now possible to follow news and announces of the\r
50 website with the following RSS feed:\r
51 &lt;a href="https://wpitchoune.net/news/feed.xml" class="bare"&gt;https://wpitchoune.net/news/feed.xml&lt;/a&gt;&lt;/p&gt;\r
52 &lt;/div&gt;\r
53 &lt;div class="paragraph"&gt;\r
54 &lt;p&gt;Under the bridge it is automaticaly generated\r
55 with a very simple program from Asciidoctor\r
56 documents. You can get the sources\r
57 from the GIT repository: &lt;a href="https://git.wpitchoune.net/asciidoctor_to_rss.git" class="bare"&gt;https://git.wpitchoune.net/asciidoctor_to_rss.git&lt;/a&gt; .&lt;/p&gt;\r
58 &lt;/div&gt;</description>\r
59       <pubDate>Sun, 03 Jul 2016 22:00:00 GMT</pubDate>\r
60       <guid isPermaLink="false">https://wpitchoune.net/news/added_rss_feed.html</guid>\r
61       <dc:date>2016-07-03T22:00:00Z</dc:date>\r
62     </item>\r
63     <item>\r
64       <title>Asciidoctor to RSS</title>\r
65       <link>https://wpitchoune.net/news/asciidoctor_to_rss.html</link>\r
66       <description>&lt;div id="preamble"&gt;\r
67 &lt;div class="sectionbody"&gt;\r
68 &lt;div class="paragraph"&gt;\r
69 &lt;p&gt;In order to ease the edition of this website and\r
70 the management of the server, I want it to be purely\r
71 static and generated from &lt;a href="http://asciidoctor.org"&gt;Asciidoctor&lt;/a&gt; documents.&lt;/p&gt;\r
72 &lt;/div&gt;\r
73 &lt;div class="paragraph"&gt;\r
74 &lt;p&gt;The &lt;em&gt;news&lt;/em&gt; part of the website is also written as Asciidoctor\r
75 documents, &lt;code&gt;asciidoctor_to_rss&lt;/code&gt; is converting them into static\r
76 HTML pages and generates a RSS 2.0 file.&lt;/p&gt;\r
77 &lt;/div&gt;\r
78 &lt;/div&gt;\r
79 &lt;/div&gt;\r
80 &lt;div class="sect1"&gt;\r
81 &lt;h2 id="_installation_of_asciidoctor_to_rss"&gt;Installation of asciidoctor_to_rss&lt;/h2&gt;\r
82 &lt;div class="sectionbody"&gt;\r
83 &lt;div class="paragraph"&gt;\r
84 &lt;p&gt;It is required to install:&lt;/p&gt;\r
85 &lt;/div&gt;\r
86 &lt;div class="ulist"&gt;\r
87 &lt;ul&gt;\r
88 &lt;li&gt;\r
89 &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
90 &lt;/li&gt;\r
91 &lt;li&gt;\r
92 &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
93 &lt;/li&gt;\r
94 &lt;/ul&gt;\r
95 &lt;/div&gt;\r
96 &lt;div class="paragraph"&gt;\r
97 &lt;p&gt;The sources can be retrieved from GIT:&lt;/p&gt;\r
98 &lt;/div&gt;\r
99 &lt;div class="listingblock"&gt;\r
100 &lt;div class="content"&gt;\r
101 &lt;pre&gt;git clone git clone https://git.wpitchoune.net/asciidoctor_to_rss.git&lt;/pre&gt;\r
102 &lt;/div&gt;\r
103 &lt;/div&gt;\r
104 &lt;div class="paragraph"&gt;\r
105 &lt;p&gt;Compilation:&lt;/p&gt;\r
106 &lt;/div&gt;\r
107 &lt;div class="listingblock"&gt;\r
108 &lt;div class="content"&gt;\r
109 &lt;pre&gt;cd asciidoctor_to_rss\r
110 mvn clean install&lt;/pre&gt;\r
111 &lt;/div&gt;\r
112 &lt;/div&gt;\r
113 &lt;/div&gt;\r
114 &lt;/div&gt;\r
115 &lt;div class="sect1"&gt;\r
116 &lt;h2 id="_howto_write_news"&gt;Howto write news&lt;/h2&gt;\r
117 &lt;div class="sectionbody"&gt;\r
118 &lt;div class="paragraph"&gt;\r
119 &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
120 and all documents must be dropped into a directory.&lt;/p&gt;\r
121 &lt;/div&gt;\r
122 &lt;div class="paragraph"&gt;\r
123 &lt;p&gt;There is not any restriction concerning the syntax because\r
124 the utility is based on the Java bridge of Asciidoctor.\r
125 I have added an attribute &lt;code&gt;date&lt;/code&gt; which allows the utility\r
126 to know the publication date of the news.&lt;/p&gt;\r
127 &lt;/div&gt;\r
128 &lt;div class="paragraph"&gt;\r
129 &lt;p&gt;Here is an example of &lt;em&gt;news&lt;/em&gt;:&lt;/p&gt;\r
130 &lt;/div&gt;\r
131 &lt;div class="listingblock"&gt;\r
132 &lt;div class="content"&gt;\r
133 &lt;pre class="highlight"&gt;&lt;code class="language-asciidoc" data-lang="asciidoc"&gt;= Asciidoctor to RSS\r
134 Jean-Philippe Orsini &amp;lt;jeanfi@gmail.com&amp;gt;\r
135 :date: 2016-11-07\r
136 :icons: font\r
137 \r
138 In order to ease the edition of this website and\r
139 the management of the server, I want it to be purely\r
140 static and generated from http://asciidoctor.org[Asciidoctor] documents.\r
141 \r
142 The _news_ part of the website is also written as Asciidoctor\r
143 documents, `asciidoctor_to_rss` is converting them into static\r
144 HTML pages and generates a RSS 2.0 file.\r
145 \r
146 == Installation of asciidoctor_to_rss\r
147 \r
148 It is required to install:\r
149 \r
150 * http://maven.apache.org/download.cgi[Apache Maven] (3.3.9)\r
151 \r
152 * http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java] (Sun JDK &amp;gt;=1.8)&lt;/code&gt;&lt;/pre&gt;\r
153 &lt;/div&gt;\r
154 &lt;/div&gt;\r
155 &lt;div class="paragraph"&gt;\r
156 &lt;p&gt;You can see few examples at\r
157 &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
158 The source document of this &lt;em&gt;news&lt;/em&gt; is at\r
159 &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
160 &lt;/div&gt;\r
161 &lt;/div&gt;\r
162 &lt;/div&gt;\r
163 &lt;div class="sect1"&gt;\r
164 &lt;h2 id="_configuration"&gt;Configuration&lt;/h2&gt;\r
165 &lt;div class="sectionbody"&gt;\r
166 &lt;div class="paragraph"&gt;\r
167 &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
168 &lt;/div&gt;\r
169 &lt;div class="paragraph"&gt;\r
170 &lt;p&gt;See an example at\r
171 &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
172 &lt;/div&gt;\r
173 &lt;div class="listingblock"&gt;\r
174 &lt;div class="content"&gt;\r
175 &lt;pre class="highlight"&gt;&lt;code class="language-text" data-lang="text"&gt;feed.title=News\r
176 feed.description=News of the wpitchoune.net website.\r
177 feed.link=https://wpitchoune.net/news/feed.xml\r
178 feed.baseurl=https://wpitchoune.net/news\r
179 \r
180 html.header.file=src/header.html&lt;/code&gt;&lt;/pre&gt;\r
181 &lt;/div&gt;\r
182 &lt;/div&gt;\r
183 &lt;div class="paragraph"&gt;\r
184 &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
185 &lt;/div&gt;\r
186 &lt;div class="paragraph"&gt;\r
187 &lt;p&gt;&lt;code&gt;feed.description&lt;/code&gt;: the description used in the RSS 2.0 file.&lt;/p&gt;\r
188 &lt;/div&gt;\r
189 &lt;div class="paragraph"&gt;\r
190 &lt;p&gt;&lt;code&gt;feed.link&lt;/code&gt;: URI of the RSS 2.0 file.&lt;/p&gt;\r
191 &lt;/div&gt;\r
192 &lt;div class="paragraph"&gt;\r
193 &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
194 &lt;/div&gt;\r
195 &lt;div class="paragraph"&gt;\r
196 &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
197 the generated HTML documents.&lt;/p&gt;\r
198 &lt;/div&gt;\r
199 &lt;/div&gt;\r
200 &lt;/div&gt;\r
201 &lt;div class="sect1"&gt;\r
202 &lt;h2 id="_run_the_utility"&gt;Run the utility&lt;/h2&gt;\r
203 &lt;div class="sectionbody"&gt;\r
204 &lt;div class="paragraph"&gt;\r
205 &lt;p&gt;The command line usage is:&lt;/p&gt;\r
206 &lt;/div&gt;\r
207 &lt;div class="listingblock"&gt;\r
208 &lt;div class="content"&gt;\r
209 &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
210 &lt;/div&gt;\r
211 &lt;/div&gt;\r
212 &lt;div class="paragraph"&gt;\r
213 &lt;p&gt;&lt;code&gt;IN_DIR&lt;/code&gt;: the directory containing the news as Asciidoctor documents.&lt;/p&gt;\r
214 &lt;/div&gt;\r
215 &lt;div class="paragraph"&gt;\r
216 &lt;p&gt;&lt;code&gt;OUT_DIR&lt;/code&gt;: the output directory which contains all generated files.&lt;/p&gt;\r
217 &lt;/div&gt;\r
218 &lt;div class="paragraph"&gt;\r
219 &lt;p&gt;&lt;code&gt;CFG_FILE&lt;/code&gt;: the path to the configuration file.&lt;/p&gt;\r
220 &lt;/div&gt;\r
221 &lt;div class="paragraph"&gt;\r
222 &lt;p&gt;The &lt;code&gt;OUT_DIR&lt;/code&gt; will contain:&lt;/p&gt;\r
223 &lt;/div&gt;\r
224 &lt;div class="ulist"&gt;\r
225 &lt;ul&gt;\r
226 &lt;li&gt;\r
227 &lt;p&gt;one HTML file for each Asciidoctor document,&lt;/p&gt;\r
228 &lt;/li&gt;\r
229 &lt;li&gt;\r
230 &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
231 &lt;/li&gt;\r
232 &lt;li&gt;\r
233 &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
234 compatible with RSS v2.0.&lt;/p&gt;\r
235 &lt;/li&gt;\r
236 &lt;/ul&gt;\r
237 &lt;/div&gt;\r
238 &lt;/div&gt;\r
239 &lt;/div&gt;</description>\r
240       <pubDate>Sun, 10 Jul 2016 22:00:00 GMT</pubDate>\r
241       <guid isPermaLink="false">https://wpitchoune.net/news/asciidoctor_to_rss.html</guid>\r
242       <dc:date>2016-07-10T22:00:00Z</dc:date>\r
243     </item>\r
244   </channel>\r
245 </rss>\r