git.wpitchoune.net Git - www.git/blob

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'>

15 <div><h2><a href='https://wpitchoune.net/news/asciidoctor_to_rss.html'>Asciidoctor to RSS</a></h2><div class='date'>2016-11-07</div><div id="preamble">

16 <div class="sectionbody">

17 <div class="paragraph">

18 <p>In order to have a website based only on Asciidoctor

19 documents, I have written a small utility which

20 converts a set of Asciidoctor documents to HTML pages and

21 generates a RSS 2.0 feed.</p>

22 </div>

23 </div>

24 </div>

25 <div class="sect1">

26 <h2 id="_installation_of_asciidoctor_to_rss">Installation of asciidoctor_to_rss</h2>

27 <div class="sectionbody">

28 <div class="paragraph">

29 <p>It is required to install:</p>

30 </div>

31 <div class="ulist">

32 <ul>

33 <li>

34 <p>maven</p>

35 </li>

36 <li>

37 <p>java (>1.7)</p>

38 </li>

39 </ul>

40 </div>

41 <div class="paragraph">

42 <p>The sources can be retrieved from GIT:</p>

43 </div>

44 <div class="listingblock">

45 <div class="content">

46 <pre>git clone git clone https://git.wpitchoune.net/asciidoctor_to_rss.git</pre>

47 </div>

48 </div>

49 <div class="paragraph">

50 <p>Compilation:</p>

51 </div>

52 <div class="listingblock">

53 <div class="content">

54 <pre>cd asciidoctor_to_rss

55 mvn clean install</pre>

56 </div>

57 </div>

58 </div>

59 </div>

60 <div class="sect1">

61 <h2 id="_howto_write_news">Howto write news</h2>

62 <div class="sectionbody">

63 <div class="paragraph">

64 <p>Each news has to be written in a separate Asciidoctor document

65 and all documents must be dropped into a directory.</p>

66 </div>

67 <div class="paragraph">

68 <p>There is not any restriction concerning the syntax because

69 the utility is based on the java bridge of Asciidoctor.

70 I have added an attribute 'date' which allows the utility

71 to know the publication date of the news.</p>

72 </div>

73 <div class="paragraph">

74 <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> .

75 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>

76 </div>

77 </div>

78 </div>

79 <div class="sect1">

80 <h2 id="_configuration">Configuration</h2>

81 <div class="sectionbody">

82 <div class="paragraph">

83 <p>The configuration of the utility can be done in text file.</p>

84 </div>

85 <div class="paragraph">

86 <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>

87 </div>

88 </div>

89 </div>

90 <div class="sect1">

91 <h2 id="_run_the_utility">Run the utility</h2>

92 <div class="sectionbody">

93 <div class="paragraph">

94 <p>The command line usage is:</p>

95 </div>

96 <div class="listingblock">

97 <div class="content">

98 <pre>asciidoctor_to_rss.sh <IN_DIR> <OUT_DIR> <CFG_FILE></pre>

99 </div>

100 </div>

101 <div class="paragraph">

102 <p><code>IN_DIR</code>: the directory containing the news as Asciidoctor documents.</p>

103 </div>

104 <div class="paragraph">

105 <p><code>OUT_DIR</code>: the output directory which contains all generated files</p>

106 </div>

107 <div class="paragraph">

108 <p><code>CFG_FILE</code>: the path to the configuration file</p>

109 </div>

110 <div class="paragraph">

111 <p>The <code>OUT_DIR</code> will contain:</p>

112 </div>

113 <div class="ulist">

114 <ul>

115 <li>

116 <p>one HTML file for each Asciidoctor document</p>

117 </li>

118 <li>

119 <p>the <code>news.html</code> file</p>

120 </li>

121 <li>

122 <p>the <code>feed.xml</code> file which is a feed compatible with RSS v2.0.</p>

123 </li>

124 </ul>

125 </div>

126 </div>

127 </div></div>

128

129 <div><h2><a href='https://wpitchoune.net/news/added_rss_feed.html'>RSS Feed</a></h2><div class='date'>2016-04-07</div><div class="paragraph">

130 <p>It is now possible to follow news and announces of the

131 website with the following RSS feed:

132 <a href="https://wpitchoune.net/news/feed.xml" class="bare">https://wpitchoune.net/news/feed.xml</a></p>

133 </div>

134 <div class="paragraph">

135 <p>Under the bridge it is automaticaly generated

136 with a very simple program from Asciidoctor

137 documents. You can get the sources

138 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>

139 </div></div>

140

141 <div><h2><a href='https://wpitchoune.net/news/new_website.html'>New website</a></h2><div class='date'>2016-14-06</div><div class="paragraph">

142 <p>After being bored with Wordpress for years, the <a href="http://wpitchoune.net">wpitchoune.net</a>

143 website is changing. It is now based on <a href="http://asciidoctor.org">Asciidoctor</a> and

144 a simple shell script to generate it.</p>

145 </div>

146 <div class="paragraph">

147 <p>With the help of <a href="http://atom.io">Atom</a> and a couple of addons dedicated to

148 Asciidoctor, it is easy and quick to write content. I am happy to no

149 more have to worry about the painful admistration of Wordpress,

150 upgrading it, taking care of security, spamming of comments and bot

151 account creation, and backup of databases.</p>

152 </div>

153 <div class="paragraph">

154 <p>If you want to know how the website is built, everything is on

155 a GIT repository: <a href="http://git.wpitchoune.net/gitweb/?p=www.git" class="bare">http://git.wpitchoune.net/gitweb/?p=www.git</a>.

156 It is simple, really simple… but enough for my needs.</p>

157 </div></div>

158

159 <div><h2><a href='https://wpitchoune.net/news/call_contribution.html'>Call for contributions for the translation of psensor</a></h2><div class='date'>2016-14-06</div><div class="paragraph">

160 <p>The version 1.2.0 of psensor is going to be released in the coming

161 weeks. This release will include many changes which impact the

162 translations. If you want to contribute to the translation of psensor

163 it is now the good timeframe. See the

164 <a href="https://wpitchoune.net/psensor/contribute.html">instructions</a>.</p>

165 </div></div>

166 </div>

167 </body>

168 </html>