[2024-feb-29] Sad news: Eric Layton aka Nocturnal Slacker aka vtel57 passed away on Feb 26th, shortly after hospitalization. He was one of our Wiki's most prominent admins. He will be missed.
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
howtos:software:asciidoc_mini_howto [2014/12/17 16:56 (UTC)] – [asciidoc Mini HOWTO] some rewording and additions pdi | howtos:software:asciidoc_mini_howto [2019/02/21 10:36 (UTC)] (current) – removed markand | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | <!-- Add your text below. We strongly advise to start with a Headline (see button bar above). --> | ||
- | ====== asciidoc Mini HOWTO ====== | ||
- | ===== Introduction ===== | ||
- | Keeping notes is an integral part of using any Linux distribution. Keeping them in plain text allows one to use them from a console during initial setup; using a consistent markup for plain text adds to the readability of the notes. | ||
- | |||
- | // | ||
- | |||
- | // | ||
- | |||
- | For an interesting read about // | ||
- | |||
- | ===== Helper Packages and Files ===== | ||
- | ==== Asciidoctor ==== | ||
- | Consider installing [[http:// | ||
- | |||
- | ==== Dblatex ==== | ||
- | To convert // | ||
- | [[http:// | ||
- | [[http:// | ||
- | |||
- | ==== Source-highlight ==== | ||
- | To highlight source listings, install | ||
- | [[http:// | ||
- | This: | ||
- | < | ||
- | [source, | ||
- | --------------------------------------------------------------------------- | ||
- | #!/bin/bash | ||
- | export LANG=en_US.UTF-8 | ||
- | --------------------------------------------------------------------------- | ||
- | </ | ||
- | |||
- | renders as (this is DokuWiki' | ||
- | <code bash> | ||
- | #!/bin/bash | ||
- | export LANG=en_US.UTF-8 | ||
- | </ | ||
- | |||
- | |||
- | ==== Vim Syntax Highlighter ==== | ||
- | If // | ||
- | |||
- | **'' | ||
- | |||
- | **'' | ||
- | |||
- | and see [[http:// | ||
- | |||
- | Highlighting can also work by inserting at the bottom of the file: | ||
- | |||
- | < | ||
- | |||
- | |||
- | |||
- | ===== User Guide ===== | ||
- | The user guide file is found in /// | ||
- | |||
- | **'' | ||
- | |||
- | and see /// | ||
- | |||
- | ===== Source Files ===== | ||
- | ==== TXT ==== | ||
- | It is a // | ||
- | |||
- | ==== Common Variables ==== | ||
- | To organize the use of common variables in all files, make a directory // | ||
- | |||
- | < | ||
- | :pathname: {pathname=/ | ||
- | </ | ||
- | |||
- | Then, at the header of each file put: | ||
- | |||
- | < | ||
- | include::/ | ||
- | </ | ||
- | |||
- | and in text use as: | ||
- | |||
- | < | ||
- | {pathname}/ | ||
- | </ | ||
- | |||
- | ==== System Attributes ==== | ||
- | Any variable that can be defined in //bash// with | ||
- | **'' | ||
- | can also be defined in // | ||
- | < | ||
- | :NAME: {sys: | ||
- | </ | ||
- | then use in text as: | ||
- | < | ||
- | {NAME} | ||
- | </ | ||
- | |||
- | ==== Man ==== | ||
- | Linking to //man// pages in HTML is very useful. See [[howtos: | ||
- | < | ||
- | http:// | ||
- | </ | ||
- | |||
- | ===== Output ===== | ||
- | ==== XHTML ==== | ||
- | To make an HTML file: | ||
- | |||
- | **'' | ||
- | |||
- | To use icons, mainly for admonition paragraphs, add the options: | ||
- | |||
- | **'' | ||
- | |||
- | |||
- | To have a fixed-width HTML, add: | ||
- | |||
- | **'' | ||
- | |||
- | |||
- | To use additional custom CSS, add: | ||
- | |||
- | **'' | ||
- | |||
- | |||
- | It may be helpful to put an alias in // | ||
- | <code bash> | ||
- | alias ad="/ | ||
- | -b xhtml11 \ | ||
- | -a icons -a max-width=45em \ | ||
- | -a iconsdir=/ | ||
- | -a stylesdir=/ | ||
- | -a stylesheet=/ | ||
- | </ | ||
- | |||
- | ==== PDF ==== | ||
- | To make a PDF file, first install [[# | ||
- | |||
- | **'' | ||
- | |||
- | **'' | ||
- | |||
- | ==== Txt2tags ==== | ||
- | Use // | ||
- | |||
- | **'' | ||
- | |||
- | |||
- | ====== Sources ====== | ||
- | <!-- If you are copying information from another source, then specify that source --> | ||
- | <!-- * Original source: [[http:// | ||
- | <!-- Authors are allowed to give credit to themselves! --> | ||
- | <!-- * Originally written by [[wiki: | ||
- | <!-- * Contributions by [[wiki: | ||
- | |||
- | <!-- Please do not modify anything below, except adding new tags.--> | ||
- | <!-- You must remove the tag-word " | ||
- | {{tag> |