mirror of https://github.com/rkd77/elinks.git synced 2024-06-24 00:56:14 +00:00
Commit Graph

57 Commits

Author SHA1 Message Date
Witold Filipczyk
4416e3be8d [python3] one time conversion of asciidoc to Python3. Refs #38
Likely it will fail on Cygwin.
2020-01-04 20:15:28 +01:00
Kalle Olavi Niemitalo
8e20417bdb Debian bug 526349: Bundle asciidoc.py with ELinks.
The AsciiDoc 7.1.2 configuration files included in the ELinks
source tree apparently aren't compatible with AsciiDoc 8.4.4:

 [ASCIIDOC]   doc/elinks.1.xml
FAILED: [listdef-bulleted] missing section: [listtags-None]
make[1]: *** [elinks.1.xml] Error 1

Fix this by including asciidoc.py from AsciiDoc 7.1.2 as well.
The build system now doesn't care at all whether the user has
installed some version of AsciiDoc or not.
2009-05-01 20:40:25 +03:00
Kalle Olavi Niemitalo
21697bfa27 Delete the unused help2doc script
The help2doc script was replaced with help2xml on 2008-05-03.
2009-05-01 00:00:42 +03:00
Kalle Olavi Niemitalo
922ef4cd9a doc fix in help2xml script 2009-04-30 22:52:49 +03:00
Kalle Olavi Niemitalo
c67885d880 Upgrade ISC licence to July 2007 version
Make it clear that modified versions may also be distributed.
I am the sole copyright holder for these ELinks files
so I can replace the licence like this.

This version of the licence is used in bind-9.5.0-P2.tar.gz.
Wikipedia claims ISC made the change in July 2007 after a request
from the FSF.
2008-09-28 23:16:37 +03:00
Kalle Olavi Niemitalo
40715ffbd4 Import and use AsciiDoc 7.1.2 configuration files
In the past, we have hit annoying incompatibilities when
people have attempted to rebuild ELinks documentation
with new versions of AsciiDoc:


So now we bundle the configuration files from a known good version
to let ELinks documentation be built with them regardless of which
version has been installed on the machine.
2008-08-02 11:28:24 +03:00
Kalle Olavi Niemitalo
604b99d5a4 help2xml: New script.
The intention is to convert --config-help and --long-help outputs to
DocBook XML and XHTML rather than AsciiDoc, so that the converter does
not have to work around the intricate AsciiDoc syntax.  However, this
commit does not yet connect the script to doc/Makefile.

XHTML could be generated from DocBook XML, but the script outputs it
directly because our DocBook is primarily intended for manual pages
and so does not have all the links that are useful in HTML.
2008-05-03 20:27:47 +03:00
Kalle Olavi Niemitalo
5fcf175963 help2doc: rewrite in Perl
This version takes about 1/300 of the time of the shell version
and fixes several errors in the output, most importantly that
option descriptions were being truncated at the first empty line.

Because help2doc is run only from make update-man, and the distributed
tarballs include prebuilt man pages, people building ELinks need not
have Perl installed.
2008-03-08 14:51:25 +02:00
Jonas Fonseca
b28ccd6e4f keys2doc: fix handling of dots (.) in description list term
Quote character keybindings to workaround unescaped (resulting to
invisible) dots in elinkskeys(5).
(cherry picked from commit 3de420d72f)
2008-03-05 10:04:47 +02:00
Jonas Fonseca
9863dbfa9c keys2doc: map the KBD_MOD_SHIFT modifier to Shift-prefix
(cherry picked from commit dc497964e9)
2008-03-05 10:01:21 +02:00
Kalle Olavi Niemitalo
d73632d7de keys2doc: Change \"foo\" to "foo". 2007-01-06 21:38:29 +02:00
Kalle Olavi Niemitalo
7b931a2de0 conf2doc: Backslashify --help, --enable, --disable to avoid —. 2006-12-27 19:41:04 +02:00
Jonas Fonseca
5edec55a86 Remove all traces of the horrid "API Doc" code documentation tool 2006-12-10 01:23:40 +01:00
Jonas Fonseca
a892c84601 Make it possible to build all-docs when $(builddir) != $(srcdir) 2006-01-16 00:21:05 +01:00
Jonas Fonseca
2748d043f9 Autogenerate .vimrc files and put the master in config/vimrc
This changes the init target to be idempotent: most importantly it will now
never overwrite a Makefile if it exists. Additionally 'make init' will
generate the .vimrc files. Yay, no more stupid 'added fairies' commits! ;)
2006-01-15 18:38:58 +01:00
Jonas Fonseca
2a4afa22b1 Minor simplification 2006-01-15 18:06:44 +01:00
Jonas Fonseca
6e79a24679 Add an empty line before titles in keymap-*.txt; fixes elinkskeys.5.html 2006-01-14 19:45:40 +01:00
Jonas Fonseca
66e9ae4957 Escape {}'s so that AsciiDoc does the right thing; fixes elinks.conf(5) 2006-01-14 19:43:58 +01:00
Jonas Fonseca
01b9ba0983 Fix keymap-%.txt building; move FIXME about prefixes to elinkskeys.5.txt 2006-01-14 19:24:46 +01:00
Jonas Fonseca
fabd3df984 mv import-features.conf conf2doc; mv make-elinkskeys-manpage keys2doc 2006-01-13 12:58:47 +01:00
Jonas Fonseca
63f4a15d91 Add ending punctuation for one-liners; fix missing ending ';' 2006-01-13 12:14:05 +01:00
Jonas Fonseca
bcdd3fafca Output only to stdout instead of creating files directly 2006-01-13 12:02:26 +01:00
Jonas Fonseca
686166d5e6 Various api doc related fixes and cleanups 2006-01-13 08:09:06 +01:00
Jonas Fonseca
aef863da96 Various minor improvements 2006-01-12 10:29:05 +01:00
Jonas Fonseca
aa7d65fb79 Make elinks.conf(5) also be build from .txt files
This simplifies help2doc since it now just have to do one single thing with
output of either --config-help or --long-help. The new manpage is not as
fancy wrt. indentation and sub titles but it is more uniform and we get a
HTML version.

Generate options-{config,command}.txt with help2doc. Only conditionally
check for API header files, to speed up execusion.
2006-01-12 08:33:50 +01:00
Jonas Fonseca
2ed9e26ebe Fix to generate listings correctly for docbook backend 2006-01-12 05:36:24 +01:00
Jonas Fonseca
ba6221c6f6 Redo the whole doc/ build thing
You can now use: make {all-docs,pdf,html,man,api,update-man}
     instead of: make {all-docs,pdf-docs,html-docs,man-docs}

Away is building into separate dirs. This makes make able to actually get
dependencies right, since there are now a collection of 'common' build
rules, some of which have even been moved to use the cmd infrastructure.

To update the man pages there is a new update-man rule. It builds the
manual pages and copies them to their proper place under man/ while doing
the final preformatting.

As good thing is that the (two) man pages are moved to .txt files and
include the generated content.

The API building thing is also refined. It builds into api/ and builds it's
list of files dynamically by searching throught the .h files in the src/
directory. Documented header files must contain a comment like this:

	/* API Doc :: <api-name> */

where <api-name> is the name used for the file under api/, for example
2006-01-11 11:02:43 +01:00
Laurent MONIN
e833c444f5 Remove obsolete elinksmanual(1) link. 2006-01-10 22:10:37 +01:00
Laurent MONIN
06dd1e2e06 Use date -I for man page date, suggested by lindi. 2006-01-10 16:15:32 +01:00
Laurent MONIN
3d837406d6 print_elinksconf_header(): fix quotes and backslashes
escaping. elinks.conf.5 was badly formatted.
2006-01-10 00:45:06 +01:00
Jonas Fonseca
0e5853cae7 More perl snacks; added macro:[] for #define'd values; api dom/scanner.h 2006-01-09 14:06:47 +01:00
Jonas Fonseca
d7edca09c3 More perl snacks 2006-01-09 12:46:13 +01:00
Jonas Fonseca
938c8a80b4 Support more implicit markup of source files 2006-01-09 11:01:36 +01:00
Jonas Fonseca
9799a66710 Code2doc v2.0 2006-01-09 08:25:03 +01:00
Jonas Fonseca
9699396658 Match against comment end once 2006-01-09 06:49:15 +01:00
Jonas Fonseca
9e23ea9eeb Replace $first with $indent to get uniform indentation and simplify 2006-01-09 06:24:00 +01:00
Jonas Fonseca
cab1380031 Obsolete $start and $gotone; tune newlines; simply line matching 2006-01-09 05:30:59 +01:00
Jonas Fonseca
41fe69f86e Handle one-liners with '/*:: ... */' upfront 2006-01-09 05:03:07 +01:00
Jonas Fonseca
4e8abf55ec Cleanup; use Getopt::Std; Loop multiple files from cmdline with <> 2006-01-09 04:49:26 +01:00
Jonas Fonseca
2d7356d29a Improve support for struct documentation by saving the struct name
This makes it easy to create

	One line description
2006-01-09 00:53:41 +01:00
Jonas Fonseca
a7fb4a71e3 Insert missing ':' after 'id', use tab for indentation 2006-01-09 00:01:09 +01:00
Jonas Fonseca
7acb3059a8 Make code2doc print to stdout 2006-01-08 23:57:14 +01:00
Russ Rowan
0eef02b8f3 Handle: SGML_PARSER_CODE_OK = 1, /**: The parsing was successful */ 2006-01-08 17:42:04 -05:00
Russ Rowan
0f8f5b0635 Undo last change and left align enums. 2006-01-08 16:57:10 -05:00
Russ Rowan
b2cbbf1139 Don't left align enums. 2006-01-08 16:46:46 -05:00
Russ Rowan
e15c9d4611 Minor code optimization. 2006-01-08 16:20:46 -05:00
Russ Rowan
4fe54a9d68 Added another blank line between each block and one between each id:[*]::
line for readability.
2006-01-08 15:54:00 -05:00
Russ Rowan
97b0635d1e Don't underline leading comment lines that contain ::. 2006-01-08 15:37:03 -05:00
Jonas Fonseca
3529b35da0 Sneak in an extra newline after section headers 2006-01-08 20:02:31 +01:00
Russ Rowan
33f373fbd5 Get rid of extraneous spaces left in the output. I have no idea if
asciidoc is sensitive enough to fail on these.
2006-01-08 13:05:11 -05:00