Retire index.txt

Put the remaining parts which didn't already get reused into manual.txt
and base a largely rewritten README on the file listing TOC.

doc/README

@@ -4,25 +4,101 @@ 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.
 
-The files you will find in this directory are manpages living in the man/
+You are encouraged to get a copy of the ELinks manual. It tries to be a
-directory and a bunch of .html and especially .txt (wait, you expect HTML
+complete book of all there is to know about ELinks. For example, most files
-browser to carry its documentation around in HTML?) documents. The index.txt
+listed in the next section is in some way part of the ELinks manual.
-file contains the table of contents which should help you navigating between
-the files.
 
-Tools
+Instructions on building the manual is given below. If you do not intend to
------
+build it yourself either access it on the ELinks homepage or, if you
+downloaded ELinks via a tarball, the manual should be in the html/ directory.
 
-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.
+Where to start
-If you want to translate .pod files you need pod2html.
+--------------
+
+This sections tries to give a quick overview of important files you will find
+in this directory or it's children.
+
+ - Man pages (*):
+
+	elinks(1) ................................... man/man1/elinks.1
+	elinks.conf(5) .............................. man/man5/elinks.conf.5
+	elinkskeys(5) ............................... man/man5/elinkskeys.5
+
+   Man pages are best viewed with the man program. The easiest way to do this
+   is by telling the man program to look for man pages in the doc/man
+   directory by using the -M switch. If you are standing in the top-level
+   directory, you can do this by invoking the man program using:
+
+	man -M doc/man elinks.conf
+
+ - User's Guide:
+
+	Getting ELinks up and running................ installation.txt
+	Introduction to the World of ELinks ......... introduction.txt
+	Frequently Asked Questions .................. faq.txt
+	JavaScript/ECMAScript in ELinks ............. ecmascript.txt
+	Notes on User Feedback ...................... feedback.txt
+	The Smallest Binary Quest Spoilerbook ....... small.txt
+
+   Note: The ELinks manual really should be read in one of the generated
+   formats: html, html-chunked or pdf, however the entry point can be found in
+   manual.txt and might be of some help, when deciding what other .txt
+   documents to read in this directory.
+
+ - Developer's Guide:
+
+	Introduction to ELinks Developing ........... dev-intro.txt
+	The Demented Guide to Source Hacking ........ hacking.txt
+
+   The developing intro tries to explain some of the basic concepts in the
+   ELinks internal. While the hacking guide contains great deal about general
+   source code structure and especially guidelines regarding coding style,
+   submitting patches etc., thus every aspiring developer should take the
+   pains to read through it, do not forget to also look for README and similar
+   text files in the subdirectories containing the relevant sources for
+   detailed notes regarding given modules/subsystems.
+
+	The Lua Scripting Book ...................... lua-scripting.txt
+	Events Reference Sheet ...................... events.txt
+
+   The above covers internal scripting, by which we mean scripting of the
+   browser internals through embedded Lua, Guile or Perl scripts. ECMAScript
+   scripts embedded in documents have nothing to do with that.
+
+
+Building documentation
+----------------------
+
+The following tools are used for generating documentation in various formats:
+
+ - asciidoc: the basic tool for lifting the .txt files to other formats.
+ - xmlto: used for outputting chunked HTML and man pages. 
+ - jw: used for pdf documents.
+ - pod2html: used for perl docs.
 
 All these tools are checked by configure, thus to successfully build all the
 possible documentation (with the tools available on the system), just run
 
 	$ make all-docs
 
-in the doc/ directory.
+in the doc/ directory. It will build, if possibly, the manual in the following
+manual formats (with tool requirements listed):
+
+ - HTML one-file (asciidoc)
+ - HTML chunked / multiple files (asciidoc + xmlto)
+ - PDF (asciidoc + jw)
+
+and the following man page formats:
+ 
+ - HTML (asciidoc)
+ - man / groff (asciidoc + xmlto)
+
+Note: You do not need to build manpages. They are shipped with ELinks.
+
+Note: You must first build the ELinks binary for "make all-docs" to work
+successfully. The binary is used for getting option documentation.
+
 
 Contributing
 ------------

doc/index.txt

@@ -1,91 +0,0 @@
-
-
-                           The ELinks Manual
-
-
-Welcome! This is the entry point for the current humble ELinks manual.
-It is by no way complete, it is not even very homogeneous and it should
-be eventually superseded by a complete ELinks Book, which you can find
-in the book/ subdirectory in a very prenatal stage.
-
-There was a complete (or from a large part complete) manual for the
-Links 0.82 once, you can still find it at:
-
-	http://links.sourceforge.net/docs/manual-0.82-en/index.html
-
-While large parts of it do not apply anymore, you may still find some
-relevant information there.
-
-You may also refer to the manual page for a very quick reference,
-however little effort is done to keep it always up-to-date.
-On the other hand, the built-in documentation is _always_ up-to-date.
-Check the --long-help and --config-help ELinks command-line arguments.
-
-
-Table of contents
-~~~~~~~~~~~~~~~~~
-
-Introduction and Table of Contents .......................... index.txt
-
-User's Guide
-	The ELinks Manual (txt) ............................ manual.txt
-	The ELinks Manual (html) .......................... manual.html
-	Other Topics
-		Frequently Asked Questions ................... faq.html
-		JavaScript/ECMAScript in ELinks ........ ecmascript.txt
-
-Man pages (*)
-	elinks(1) ................................... man/man1/elinks.1
-	elinks.conf(5) ......................... man/man5/elinks.conf.5
-	elinkskeys(5) ........................... man/man5/elinkskeys.5
-
-Developer's Guide
-	Internal Scripting (**)
-		The Lua Scripting Book ................ elinks-lua.texi
-		On the Perl Scripting Interface ........ (***) perl.pod
-		Events Reference Sheet (****) .............. events.txt
-	The Demented Guide to Source Hacking (*****) ...... hacking.txt
-	The Smallest Binary Quest Spoilerbook ............... small.txt
-	A Discursus on Color Models ................... color-model.txt
-
-Appendices
-	Appendix A - Notes on User Feedback .............. feedback.txt
-
-(*) Man pages are best viewed with the man program. The easiest way to
-do this is by telling the man program to look for man pages in the
-doc/man directory by using the -M switch. If you are standing in the
-top-level directory, you can do this by invoking the man program using:
-
-	man -M doc/man elinks.conf
-
-(**) By internal scripting, we mean scripting of the browser internals
-through embedded Lua, Guile or Perl scripts. ECMAScript scripts
-embedded in documents have nothing to do with that.
-
-(***) This document is written in the Plain Old Documentation format,
-traditional for any Perl-related documentation. You can either view
-it directly by the 'perldoc' tool or convert it to a more reading-
--friendly format by one of the numerous 'pod2' tools, most notably
-'pod2text' and 'pod2html'. All those tools should be part of your
-Perl distribution (some Linux distributions have a separate 'perldoc'
-package).
-
-(****) De iure, this is not restricted to internal scripting and should
-be of general interest. De facto, it is currently interesting almost
-exclusively to hackers in the internal scripting area - and shall it
-be very useful resource for internal scripting power users.
-
-(*****) While that file contains great deal about general source code
-structure and especially guidelines regarding coding style, submitting
-patches etc., thus every aspiring developer should take the pains
-to read through it, do not forget to also look for README and similar
-text files in the subdirectories containing the relevant sources for
-detailed notes regarding given modules/subsystems.
-
-
-
-
-
-(Note: Sometimes, I broke the lines manually earlier than gqap would,
-for greater aesthetical effect. --pasky)
-vim: textwidth=72

doc/manual.txt

@@ -1,14 +1,15 @@
 The ELinks Manual
 =================
-:Revision:	$Revision: 1.18 $
-:Date:		$Date: 2005/05/18 18:55:14 $
 
 Preface
 -------
 
 Welcome!  This is the entry point for the humble ELinks manual.  It is by no
 means complete, it is not even very homogeneous and it should eventually be
-superseded by a complete ELinks Book.
+superseded by a complete ELinks Book. Until this happens you may also find it
+necessary to refer to the manual page for a very quick reference, or the
+built-in documentation available via the --long-help and --config-help ELinks
+command-line arguments. The built-in documentation is sure to be up-to-date.
 
 There was a complete (or, for the most part complete) manual for Links 0.82 at
 one time, and you can still find it at: