2 Jean-Philippe Orsini <jeanfi@gmail.com>
6 In order to ease the edition of this website and
7 the management of the server, I want it to be purely
8 static and generated from http://asciidoctor.org[Asciidoctor] documents.
10 The _news_ part of the website is also written as Asciidoctor
11 documents, `asciidoctor_to_rss` is converting them into static
12 HTML pages and generates a RSS 2.0 file.
14 == Installation of asciidoctor_to_rss
16 It is required to install:
18 * http://maven.apache.org/download.cgi[Apache Maven] (3.3.9)
20 * http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java] (Sun JDK >=1.8)
22 The sources can be retrieved from GIT:
25 git clone git clone https://git.wpitchoune.net/asciidoctor_to_rss.git
37 Each _news_ must be written in an http://asciidoctor.org[Asciidoctor] document
38 and all documents must be dropped into a directory.
40 There is not any restriction concerning the syntax because
41 the utility is based on the Java bridge of Asciidoctor.
42 I have added an attribute `date` which allows the utility
43 to know the publication date of the news.
45 Here is an example of _news_:
50 Jean-Philippe Orsini <jeanfi@gmail.com>
54 In order to ease the edition of this website and
55 the management of the server, I want it to be purely
56 static and generated from http://asciidoctor.org[Asciidoctor] documents.
58 The _news_ part of the website is also written as Asciidoctor
59 documents, `asciidoctor_to_rss` is converting them into static
60 HTML pages and generates a RSS 2.0 file.
62 == Installation of asciidoctor_to_rss
64 It is required to install:
66 * http://maven.apache.org/download.cgi[Apache Maven] (3.3.9)
68 * http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java] (Sun JDK >=1.8)
71 You can see few examples at
72 https://wpitchoune.net/gitweb/?p=www.git;a=tree;f=src/news;hb=HEAD.
73 The source document of this _news_ is at
74 https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/news/asciidoctor_to_rss.adoc;hb=HEAD.
78 The configuration file of `asciidoctor_to_rss` is text file containing key/value pairs.
81 https://wpitchoune.net/gitweb/?p=www.git;a=blob;f=src/asciidoctorrss.props;hb=HEAD .
86 feed.description=News of the wpitchoune.net website.
87 feed.link=https://wpitchoune.net/news/feed.xml
88 feed.baseurl=https://wpitchoune.net/news
90 html.header.file=src/header.html
93 `feed.title`: the title used for the feed, in the RSS 2.0 and `news.html` files.
95 `feed.description`: the description used in the RSS 2.0 file.
97 `feed.link`: URI of the RSS 2.0 file.
99 `feed.baseurl`: base URI where the HTML news files will be located.
101 `html.header.file`: the content of the denoted file will be added in the `head` block of
102 the generated HTML documents.
106 The command line usage is:
109 asciidoctor_to_rss.sh <IN_DIR> <OUT_DIR> <CFG_FILE>
112 `IN_DIR`: the directory containing the news as Asciidoctor documents.
114 `OUT_DIR`: the output directory which contains all generated files.
116 `CFG_FILE`: the path to the configuration file.
118 The `OUT_DIR` will contain:
120 * one HTML file for each Asciidoctor document,
122 * the https://wpitchoune.net/news/news.html[`news.html`] file,
124 * and the https://wpitchoune.net/news/news.html[`feed.xml`] file which is a feed
125 compatible with RSS v2.0.