www/news/news.html

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