git.saurik.com Git - wxWidgets.git/blame_incremental - contrib/docs/latex/fl/readme.txt

... / ...

Commit	Line	Data
	1	Generating the FL Reference Manual
	2	===================================
	3
	4	Like the wxWindows manual, the FL manual uses Tex2RTF to
	5	generate HTML, MS HTML Help, wxHTML Help, WinHelp, RTF, and PDF
	6	formats.
	7
	8	VC++ users can use makefile.vc in this directory, e.g.:
	9
	10	nmake -f makefile.vc docs ; Create directories and
	11	; all formats
	12
	13	or
	14
	15	nmake -f makefile.vc dirs html ; Create directories, then
	16	; HTML files
	17
	18	The targets that the makefile supports are:
	19
	20	html ; HTML
	21	htb ; wxHTML Help: the HTML files + hhp, hhc files,
	22	; archived in a fl.htb (zip format) file
	23	htmlhelp ; MS HTML Help: the HTML files + hhp, hhc files
	24	; then processed with hhc to produce fl.chm
	25	winhelp ; WinHelp format: Tex2RTF produces RTF and CNT
	26	; files, then the makefile invokes hc.exe to produce
	27	; the fl.hlp file
	28	rtf: ; WinHelp RTF (intermediate stage for winhelp)
	29	pdfrtf ; Makes an RTF file suitable for loading into
	30	; MS Word and generating a PDF via Adobe Acrobat
	31
	32	If you wish to run Tex2RTF directly, you can do e.g.
	33
	34	tex2rtf $(DOCDIR)\latex\FL\manual.tex $(DOCDIR)\html\FL\fl.htm -twice -html
	35
	36	For more information on using Tex2RTF, please see:
	37
	38	docs/tech/tn0003.txt: Adding wxWindows class documentation
	39
	40	in the wxWindows hierarchy, and also utils/tex2rtf. The Tex2RTF
	41	manual is supplied with wxWindows documentation, in (for example)
	42	docs/html/tex2rtf/t2rtf.htm or docs/htmlhelp/tex2rtf.chm.
	43
	44	You can configure the way Tex2RTF works with tex2rtf.ini in
	45	docs/latex/fl.
	46
	47	Generating HTML format
	48	======================
	49
	50	To generate HTML documentation, you need to use the -html
	51	argument to Tex2RTF. A whole directory of files will be
	52	generated.
	53
	54	Generating MS HTML Help format
	55	==============================
	56
	57	To generate MS HTML Help documentation, you need to generate
	58	the HTML files as above and then run
	59
	60	hhc fl.hhp
	61
	62	You'll need the MS HTML Help compiler, obtainable from Microsoft
	63	or bundled with your C++ compiler.
	64
	65	Generating wxHTML Help format
	66	=============================
	67
	68	To generate wxHTML Help documentation, you need to generate
	69	the HTML files as above and then archive the HTML, image,
	70	hhc, hhp and optionally hhk files into fl.htb.
	71
	72	The helpview program can be used to view fl.htb
	73	on supported platforms. Get it from the wxWindows web site
	74	or compile it with samples/html/helpview in the wxWindows
	75	distribution.
	76
	77	Generating WinHelp format
	78	=========================
	79
	80	To generate Windows Help documentation, you need to generate
	81	the RTF file and contents file (.cnt) using --winhelp and
	82	then run hc.exe to produce the .hlp file
	83
	84	Generating PDF format
	85	=====================
	86
	87	Run Tex2RTF with the -rtf argument, load the RTF into MS Word,
	88	select the whole document, press F9, then apply wordstyle.dot
	89	found in distrib/msw in the wxWindows distribution.
	90	Then generate the PDF using Adobe Acrobat PDFWriter.
	91
	92	Note that for the contents to be formatted correctly,
	93	each class section should end with a blank line. Otherwise
	94	the contents will have bits of the reference in it.
	95
	96	Generating .tex files from .h files
	97	===================================
	98
	99	Much of the class reference is generated from the headers.
	100	The intention is to comment the headers more thoroughly, then
	101	regenerate the .tex files, before working directly on the
	102	.tex files.
	103
	104	To regenerate .tex files, you'll need the HelpGen utility from
	105	latest wxWindows CVS, in utils/helpgen/src. Compile wxBase,
	106	then HelpGen. Run helpgen with e.g.
	107
	108	helpgen dump file.h
	109
	110	and a separate .tex file for each class will appear in the
	111	current directory.
	112
	113	--
	114	Julian Smart, January 3rd 2002
	115	julian.smart@btopenworld.com
	116