Summary:ASTERISK-22439: Improve Asterisk Admin Guide output
Reporter:Matt Jordan (mjordan)Labels:
Date Opened:2013-09-03 06:55:00Date Closed:2013-09-18 15:55:15
Versions:Frequency of
Description:The exported documentation that forms the Asterisk Admin Guide in a release has some general presentation issues. This includes:
* Lack of page numbers
* Lack of logical separation between pages
* Poorly formatted TOC (too long, rolling page numbers)

It could probably use a title page, as well as a few subsection header pages as well.
Comments:By: Rusty Newton (rnewton) 2013-09-05 09:51:32.167-0500

An item to add. The Asterisk-Admin-Guide-12.html.zip ends up in the root of the tarball. I think it should be in the /doc directory where the .pdf is.

By: Olle Johansson (oej) 2013-09-05 11:56:29.221-0500

I think we need to change formatting to more information per page and divide it into multiple files. Something that's over 1000 pages is just wrong.

By: Matt Jordan (mjordan) 2013-09-05 13:45:22.643-0500

Well, one easy dividing point would be to pull out the command reference information into a reference guide, and the installation/configuration stuff into a different guide.

By: Matt Jordan (mjordan) 2013-09-05 13:45:51.138-0500

(And yes, the .html.zip is in the wrong location, but that was human error on my part. The releaser scripts blew up during the release and that part was done by hand; that won't occur on any subsequent release).

By: Matt Jordan (mjordan) 2013-09-18 10:47:26.514-0500

So here's what I've done:
# Added a better title page.
# Fixed the roll over numbering on the TOC.
# Added page breaks
# Added page numbers
# Broken documentation for this into two files: an Admin Guide (which contains the version agnostic setup/configuration information) and a version specific Configuration Guide. Those will get included with the particular version tarballs.

The files will still be large, but a bit more manageable.

By: Matt Jordan (mjordan) 2013-09-18 10:47:43.402-0500

Ah, and the font size of the content *should* be smaller so more content gets put on each page.

By: Matt Jordan (mjordan) 2013-09-18 10:49:16.696-0500

I will be the first to admit, by the way, that some of the content needs improvement. But the style of the PDF should be better at least.