[Home]

Summary:ASTERISK-15991: [patch] Add ability to generate an ASCII document from the TeX files
Reporter:Leif Madsen (lmadsen)Labels:
Date Opened:2010-04-21 10:55:28Date Closed:2010-04-21 14:44:21
Priority:TrivialRegression?No
Status:Closed/CompleteComponents:Documentation
Versions:Frequency of
Occurrence
Related
Issues:
Environment:Attachments:( 0) asterisk.txt.patch
( 1) asterisk.txt.patch-v2
( 2) asterisk.txt.patch-v3
( 3) asterisk.txt.patch-v4
Description:I've added the ability to run 'make asterisk.txt' (or 'make txt') just like the current 'make asterisk.pdf' stuff.

Included in the patch is:

* fixed up several .tex files that weren't escaping characters correctly. This would lead to Unicode characters in the text file. I've fixed all of them (there are a few U+0000 and U+00FF stuff in the app_sms.tex file, but those are on purpose)

* updated the configure script to check for catdvi (used to convert the latex to text)

* updated the Makefiles

* updated the build_tools/prep_tarball script so that when we build new releases going forward we'll generate the asterisk.txt file as well.

****** STEPS TO REPRODUCE ******

Run:

$ ./configure
$ make asterisk.txt

****** ADDITIONAL INFORMATION ******

This was based off a discussion in #asterisk where ManxPower requested that we supply the ability to read the contents of a .tex file as .txt as PDFs are not always easily read from the console :)
Comments:By: Leif Madsen (lmadsen) 2010-04-21 10:59:47

Deleted the file because I modified the wrong thing for the configure script. Will reupload in a few.
By: Leif Madsen (lmadsen) 2010-04-21 12:09:20

Note that I have the change to include/asterisk/autoconfig.h.in included here, and it wasn't necessary. It was generated by ./bootstrap.sh
By: Paul Belanger (pabelanger) 2010-04-21 14:01:23

v4: minor fix to force make to exit properly.
By: Digium Subversion (svnbot) 2010-04-21 14:18:37

Repository: asterisk
Revision: 258351

U   trunk/Makefile
U   trunk/build_tools/prep_tarball
U   trunk/configure
U   trunk/configure.ac
_U  trunk/doc/tex/
U   trunk/doc/tex/Makefile
U   trunk/doc/tex/ael.tex
U   trunk/doc/tex/asterisk.tex
U   trunk/doc/tex/cel-doc.tex
U   trunk/doc/tex/enum.tex
U   trunk/doc/tex/localchannel.tex
U   trunk/doc/tex/phoneprov.tex
U   trunk/doc/tex/security-events.tex
U   trunk/include/asterisk/autoconfig.h.in
U   trunk/makeopts.in

------------------------------------------------------------------------
r258351 | lmadsen | 2010-04-21 14:18:36 -0500 (Wed, 21 Apr 2010) | 20 lines

Add ability to generate ASCII documentation from the TeX files.

These changes add the ability to run 'make asterisk.txt' just like the existing
'make asterisk.pdf' commands to generate a text document from the TeX files we
have in the doc/tex/ directory. I've also updated a few of the .tex files because
they weren't properly escaping certain characters so they would show up as Unicode
characters (like [U+021C]). Made changes to the configure scripts so it would
detect the catdvi program which is required to convert the .dvi file generated
by latex.

I've also added a few lines to the build_tools/prep_tarball script so that the
text documentation gets generated and added to future tarballs of Asterisk
releases.

(closes issue ASTERISK-15991)
Reported by: lmadsen
Patches:
     asterisk.txt.patch uploaded by lmadsen (license 10)
     asterisk.txt.patch-v4 uploaded by pabelanger (license 224)
Tested by: lmadsen, pabelanger
------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=258351
By: Digium Subversion (svnbot) 2010-04-21 14:27:41

Repository: asterisk
Revision: 258383

U   trunk/doc/tex/asterisk.tex

------------------------------------------------------------------------
r258383 | lmadsen | 2010-04-21 14:27:41 -0500 (Wed, 21 Apr 2010) | 3 lines

Fix change in asterisk.tex that got merged in after testing.

(issue ASTERISK-15991)
------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=258383
By: Digium Subversion (svnbot) 2010-04-21 14:30:19

Repository: asterisk
Revision: 258384

_U  branches/1.6.2/
U   branches/1.6.2/Makefile
U   branches/1.6.2/build_tools/prep_tarball
U   branches/1.6.2/configure.ac
_U  branches/1.6.2/doc/tex/
U   branches/1.6.2/doc/tex/Makefile
U   branches/1.6.2/doc/tex/ael.tex
U   branches/1.6.2/doc/tex/asterisk.tex
U   branches/1.6.2/doc/tex/enum.tex
U   branches/1.6.2/doc/tex/localchannel.tex
U   branches/1.6.2/doc/tex/phoneprov.tex
U   branches/1.6.2/makeopts.in

------------------------------------------------------------------------
r258384 | lmadsen | 2010-04-21 14:30:19 -0500 (Wed, 21 Apr 2010) | 28 lines

Merged revisions 258351 via svnmerge from
https://origsvn.digium.com/svn/asterisk/trunk

........
 r258351 | lmadsen | 2010-04-21 14:18:35 -0500 (Wed, 21 Apr 2010) | 20 lines
 
 Add ability to generate ASCII documentation from the TeX files.
 
 These changes add the ability to run 'make asterisk.txt' just like the existing
 'make asterisk.pdf' commands to generate a text document from the TeX files we
 have in the doc/tex/ directory. I've also updated a few of the .tex files because
 they weren't properly escaping certain characters so they would show up as Unicode
 characters (like [U+021C]). Made changes to the configure scripts so it would
 detect the catdvi program which is required to convert the .dvi file generated
 by latex.
 
 I've also added a few lines to the build_tools/prep_tarball script so that the
 text documentation gets generated and added to future tarballs of Asterisk
 releases.
 
 (closes issue ASTERISK-15991)
 Reported by: lmadsen
 Patches:
       asterisk.txt.patch uploaded by lmadsen (license 10)
       asterisk.txt.patch-v4 uploaded by pabelanger (license 224)
 Tested by: lmadsen, pabelanger
........

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=258384
By: Digium Subversion (svnbot) 2010-04-21 14:31:50

Repository: asterisk
Revision: 258385

U   branches/1.6.2/configure

------------------------------------------------------------------------
r258385 | lmadsen | 2010-04-21 14:31:50 -0500 (Wed, 21 Apr 2010) | 3 lines

Forgot to merge the updated configure script.

(issue ASTERISK-15991)
------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=258385
By: Digium Subversion (svnbot) 2010-04-21 14:44:21

Repository: asterisk
Revision: 258386

U   branches/1.6.2/doc/tex/asterisk.tex

------------------------------------------------------------------------
r258386 | lmadsen | 2010-04-21 14:44:21 -0500 (Wed, 21 Apr 2010) | 3 lines

Remove missed line in previous merge.

(issue ASTERISK-15991)
------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=258386