2005-09-15 09:58:31 -04:00
|
|
|
Overview of the ELinks documentation
|
|
|
|
|
|
2005-09-16 21:16:24 -04:00
|
|
|
There is only limited documentation available for ELinks so far, sorry. It
|
|
|
|
|
basically consists of the documents in this directory and the features.conf,
|
|
|
|
|
README and INSTALL files in the project's root directory.
|
2005-09-15 09:58:31 -04:00
|
|
|
|
2005-09-16 21:16:24 -04:00
|
|
|
The files you will find in this directory are manpages living in the man/
|
2005-09-15 09:58:31 -04:00
|
|
|
directory and a bunch of .html and especially .txt (wait, you expect HTML
|
2005-09-16 21:16:24 -04:00
|
|
|
browser to carry its documentation around in HTML?) documents. The index.txt
|
|
|
|
|
file contains the table of contents which should help you navigating between
|
|
|
|
|
the files.
|
2005-09-15 09:58:31 -04:00
|
|
|
|
|
|
|
|
Tools
|
|
|
|
|
-----
|
|
|
|
|
|
2005-09-16 21:16:24 -04:00
|
|
|
The manual is written in asciidoc, however you will also need xmlto to process
|
|
|
|
|
docbook XML generated by asciidoc into manpages and the html-chunked manual.
|
|
|
|
|
If you want to translate .pod files you need pod2html.
|
2005-09-15 09:58:31 -04:00
|
|
|
|
2005-09-16 21:16:24 -04:00
|
|
|
All these tools are checked by configure, thus to successfully build all the
|
|
|
|
|
possible documentation (with the tools available on the system), just run
|
2005-09-15 09:58:31 -04:00
|
|
|
|
|
|
|
|
$ make all-docs
|
|
|
|
|
|
|
|
|
|
in the doc/ directory.
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
------------
|
|
|
|
|
|
2005-09-16 21:16:24 -04:00
|
|
|
Contributions are very warmly welcomed, whether it is fixing typos or bad
|
|
|
|
|
grammar, rewritings or new material. Any information relevant to ELinks usage
|
|
|
|
|
can be included in the manual, including FAQ material, tips and cheats ;)
|
2005-09-15 09:58:31 -04:00
|
|
|
|
2005-09-16 21:16:24 -04:00
|
|
|
There is no strict codingstyle, but please don't limit your use of whitespaces
|
2005-09-15 09:58:31 -04:00
|
|
|
and take a look at the style used in the current documents to get ideas of what
|
|
|
|
|
is reasonable.
|
|
|
|
|
|
2005-09-16 21:16:24 -04:00
|
|
|
Contributions should be sent to Jonas Fonseca <fonseca@diku.dk> or to the
|
|
|
|
|
ELinks mailing list. If you are changing something in an existing document,
|
|
|
|
|
please read about how to make unified patches in the Patches section of the
|
|
|
|
|
doc/hacking.txt file.
|
2005-09-15 09:58:31 -04:00
|
|
|
|
|
|
|
|
$Id: README,v 1.14 2005/05/24 19:05:14 jonas Exp $
|
