rengerated
[www.git] / www / news / feed.xml
index 90183ef..c84e42c 100644 (file)
@@ -94,13 +94,29 @@ The source document of this news is at <a href="https://wpitchoune.net/gitweb
 </div>\r
 </div>\r
 <div class="paragraph">\r
-<p><code>IN_DIR</code>:</p>\r
+<p><code>IN_DIR</code>: the directory containing the news as Asciidoctor documents.</p>\r
 </div>\r
 <div class="paragraph">\r
-<p><code>OUT_DIR</code>:</p>\r
+<p><code>OUT_DIR</code>: the output directory which contains all generated files</p>\r
 </div>\r
 <div class="paragraph">\r
-<p><code>CFG_FILE</code>:</p>\r
+<p><code>CFG_FILE</code>: the path to the configuration file</p>\r
+</div>\r
+<div class="paragraph">\r
+<p>The <code>OUT_DIR</code> will contain:</p>\r
+</div>\r
+<div class="ulist">\r
+<ul>\r
+<li>\r
+<p>one HTML file for each Asciidoctor document</p>\r
+</li>\r
+<li>\r
+<p>the <code>news.html</code> file</p>\r
+</li>\r
+<li>\r
+<p>the <code>feed.xml</code> file which is a feed compatible with RSS v2.0.</p>\r
+</li>\r
+</ul>\r
 </div>\r
 </div>\r
 &lt;/div&gt;</description>\r