diff options
Diffstat (limited to 'docs/en/erlang.mk/1/guide/asciidoc/index.html')
| -rw-r--r-- | docs/en/erlang.mk/1/guide/asciidoc/index.html | 107 |
1 files changed, 35 insertions, 72 deletions
diff --git a/docs/en/erlang.mk/1/guide/asciidoc/index.html b/docs/en/erlang.mk/1/guide/asciidoc/index.html index bb13a400..530c81cc 100644 --- a/docs/en/erlang.mk/1/guide/asciidoc/index.html +++ b/docs/en/erlang.mk/1/guide/asciidoc/index.html @@ -62,100 +62,63 @@ <h1 class="lined-header"><span>AsciiDoc documentation</span></h1> -<div class="paragraph"><p>Erlang.mk provides rules for generating documentation from -AsciiDoc files. It can automatically build a user guide PDF, -chunked HTML documentation and Unix manual pages.</p></div> -<div class="sect1"> +<p>Erlang.mk provides rules for generating documentation from AsciiDoc files. It can automatically build a user guide PDF, chunked HTML documentation and Unix manual pages.</p> <h2 id="_requirements">Requirements</h2> -<div class="sectionbody"> -<div class="paragraph"><p>It is necessary to have <a href="http://asciidoc.org/">AsciiDoc</a>, -<a href="http://xmlsoft.org/XSLT/xsltproc2.html">xsltproc</a> and -<a href="http://dblatex.sourceforge.net/">dblatex</a> installed on your -system for Erlang.mk to generate documentation from AsciiDoc sources.</p></div> -</div> -</div> -<div class="sect1"> +<p>It is necessary to have <a href="http://asciidoc.org/">AsciiDoc</a>, <a href="http://xmlsoft.org/XSLT/xsltproc2.html">xsltproc</a> and <a href="http://dblatex.sourceforge.net/">dblatex</a> installed on your system for Erlang.mk to generate documentation from AsciiDoc sources.</p> <h2 id="_writing_asciidoc_documentation">Writing AsciiDoc documentation</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="http://asciidoc.org/">AsciiDoc</a> is a text document format for -writing notes, documentation, articles, books, ebooks, slideshows, -web pages, man pages and blogs. AsciiDoc files can be translated -to many formats including HTML, PDF, EPUB, man page.</p></div> -<div class="paragraph"><p>The <a href="http://asciidoc.org/userguide.html">AsciiDoc user guide</a> -describes the AsciiDoc syntax.</p></div> -<div class="paragraph"><p>The <a href="https://github.com/ninenines/erlang.mk/tree/master/doc/src/guide">Erlang.mk user guide</a> -is written in AsciiDoc and can be used as an example. The entry -file is <a href="https://github.com/ninenines/erlang.mk/blob/master/doc/src/guide/book.asciidoc">book.asciidoc</a>.</p></div> -<div class="paragraph"><p>Erlang.mk expects you to put your documentation in a specific -location. This is <em>doc/src/guide/</em> for the user guide, and -<em>doc/src/manual/</em> for the function reference. In the case of -the user guide, the entry point is always <em>doc/src/guide/book.asciidoc</em>.</p></div> -<div class="paragraph"><p>For manual pages, it is good practice to use section 3 for -modules, and section 7 for the application itself.</p></div> -</div> -</div> -<div class="sect1"> +<p><a href="http://asciidoc.org/">AsciiDoc</a> is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page.</p> +<p>The <a href="http://asciidoc.org/userguide.html">AsciiDoc user guide</a> describes the AsciiDoc syntax.</p> +<p>The <a href="https://github.com/ninenines/erlang.mk/tree/master/doc/src/guide">Erlang.mk user guide</a> is written in AsciiDoc and can be used as an example. The entry file is <a href="https://github.com/ninenines/erlang.mk/blob/master/doc/src/guide/book.asciidoc">book.asciidoc</a>.</p> +<p>Erlang.mk expects you to put your documentation in a specific location. This is <em>doc/src/guide/</em> for the user guide, and <em>doc/src/manual/</em> for the function reference. In the case of the user guide, the entry point is always <em>doc/src/guide/book.asciidoc</em>.</p> +<p>For manual pages, it is good practice to use section 3 for modules, and section 7 for the application itself.</p> <h2 id="_configuration">Configuration</h2> -<div class="sectionbody"> -<div class="paragraph"><p>All of the AsciiDoc related configuration can be done directly -inside the files themselves.</p></div> -</div> -</div> -<div class="sect1"> +<p>All of the AsciiDoc related configuration can be done directly inside the files themselves.</p> <h2 id="_usage">Usage</h2> -<div class="sectionbody"> -<div class="paragraph"><p>To build all documentation:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>To build all documentation:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make docs</tt></pre></div></div> -<div class="paragraph"><p>To build only the AsciiDoc documentation:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make docs</tt></pre> +</div></div> +<p>To build only the AsciiDoc documentation:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make asciidoc</tt></pre></div></div> -<div class="paragraph"><p>To build only the user guide:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make asciidoc</tt></pre> +</div></div> +<p>To build only the user guide:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make asciidoc-guide</tt></pre></div></div> -<div class="paragraph"><p>To build only the manual:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make asciidoc-guide</tt></pre> +</div></div> +<p>To build only the manual:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make asciidoc-manual</tt></pre></div></div> -<div class="paragraph"><p>To install man pages on Unix:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make asciidoc-manual</tt></pre> +</div></div> +<p>To install man pages on Unix:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make install-docs</tt></pre></div></div> -<div class="paragraph"><p>Erlang.mk allows customizing the installation path and sections -of the man pages to be installed. The <code>MAN_INSTALL_PATH</code> variable -defines where man pages will be installed. It defaults to -<em>/usr/local/share/man</em>. The <code>MAN_SECTIONS</code> variable defines -which manual sections are to be installed. It defaults to <code>3 7</code>.</p></div> -<div class="paragraph"><p>To install man pages to a custom location:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make install-docs</tt></pre> +</div></div> +<p>Erlang.mk allows customizing the installation path and sections of the man pages to be installed. The <code>MAN_INSTALL_PATH</code> variable defines where man pages will be installed. It defaults to <em>/usr/local/share/man</em>. The <code>MAN_SECTIONS</code> variable defines which manual sections are to be installed. It defaults to <code>3 7</code>.</p> +<p>To install man pages to a custom location:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make install-docs <span style="color: #009900">MAN_INSTALL_PATH</span><span style="color: #990000">=</span>/opt/share/man</tt></pre></div></div> -<div class="paragraph"><p>Note that you may need to run the install commands using -<code>sudo</code> or equivalent if the location is not writeable by -your user.</p></div> -</div> -</div> +<pre><tt>$ make install-docs <font color="#009900">MAN_INSTALL_PATH</font><font color="#990000">=</font>/opt/share/man</tt></pre> +</div></div> +<p>Note that you may need to run the install commands using <code>sudo</code> or equivalent if the location is not writeable by your user.</p> + |