Hi,
Attached is a patch for the 'fpcdocs' repository. This patch adds
support for IPF output via the makefile.
I have also updated the readme file with various sections and new
information about IPF support.
Note:
fpcmake needs to be run after the patch has been applied, so a new
default Makefile is generated.
--
Regards,
- Graeme -
_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/
Index: README.DOCS
===================================================================
--- README.DOCS (revision 560)
+++ README.DOCS (working copy)
@@ -3,21 +3,49 @@
All documentation is stored here, in LaTeX format and in fpdoc format.
it uses special style files (fpc*.sty) which are also in the directory.
+Available Options
+-----------------
+To see a list of all available "target" output formats, run the following
+command:
+
+ $ make help
+
do a 'make dvi' to produce the dvi format of the docs.
a 'make html' will produce the html version (using tex4ht).
a 'make ps' will produce PostScript documents.
a 'make pdf' will produce PDF (Portable Document Format) documents.
a 'make txt' will produce plain text documents.
-If you only want the html reference documentation, type
+If you only want the html reference documentation (fpdoc format), type
-make rtl.chk
-make fcl.chk
+ $ make rtl.chk
+ $ make fcl.chk
+The html target output format has some variations as well. The two
+commands above will generate the standard html output in sub-directories.
+
+Two variations are both html output, but in a single file format.
+
+
+CHM - Compressed HTML Help
+--------------------------
When the HTMLFMT environment variable is set to "chm", make html (fpdoc)
will compress the html files to .chm files. The environment variable
CSSFILE can be used to override the style file (.css).
+
+IPF - OS/2 Information Presentation Facility
+--------------------------------------------
+When the HTMLFMT environment variable is set to "ipf", make html (fpdoc)
+will generate a single .ipf file that contains all the documentation. This
+.ipf file can then be compiled with the IPFC compiler (external tool) to
+generate the final .INF help file.
+
+ $ make rtl.chk HTMLFMT=ipf FPCSRCDIR=/path/to/fpc/source
+
+
+General Settings
+----------------
The reference documentation and the list of compiler messages are
created from the FPC sources. For this to work correctly, the
documentation should be in the same directory as the rest of the
@@ -36,14 +64,17 @@
/FPC/fpcsrc/compiler
/rtl
/packages
-
- /fpcdocs
+ /fpcdocs
If you have the sources in another location, you can specify their
location through the FPCSRCDIR makefile variable, e.g like in:
-make html FPCSRCDIR=/path/to/fpc/sources
+ $ make html FPCSRCDIR=/path/to/fpc/sources
+or an example of generating HTML reference documentation only:
+
+ $ make rtl.chk fcl.chk FPCSRCDIR=/path/to/fpc/sources
+
If you want to produce dos docs, you can do a 'make htm' this will convert
the .html files to .htm files (including all references), suitable for a 8:3
format.
@@ -53,7 +84,9 @@
THE DOCS...
-Why LaTeX ?
+
+Why LaTeX ?
+-----------
- because I like a printed copy of the manuals, HTML just isn't good enough
for this.
- I know LaTeX very well :) (mind you : html also !)
@@ -62,7 +95,9 @@
In order to translate the user manuals to HTML, I use tex4ht.
+
Why fpdoc ?
+-----------
- Because it always creates up-to-date documentation.
- The documentation is separate from the units contrary to many other
documentation tools which require comments in the sources, which makes
@@ -70,8 +105,8 @@
- It's written in FPC.
-
Then how to proceed ?
+---------------------
If you just want to write general latex docs, just use fpc.sty.
fpc.sty.doc describes what fpc.sty does. (one day I'll integrate them using
the doc package, but I need some time for it)
Index: Makefile.fpc
===================================================================
--- Makefile.fpc (revision 560)
+++ Makefile.fpc (working copy)
@@ -112,6 +112,10 @@
endif
endif
+ifeq (ipf,$(HTMLFMT))
+ HTMLSUFFIX:=.ipf
+# FPDOCHTMLOPTS+=--auto-toc --auto-index --make-searchable
+endif
#######################################################################
@@ -206,6 +210,7 @@
HTML = $(DOCS)
CHM = $(addsuffix .chm, $(DOCS))
CHK = $(addsuffix .chk, $(DOCS))
+IPF = $(addsuffix .ipf, $(DOCS))
#####################################################################
@@ -261,6 +266,7 @@
@echo ' ps : Make documentation using latex and dvips.'
@echo ' html : Make HTML documentation using default converter.'
@echo ' chm : Make Compressed HTML documentation. (only the FCL and RTL)'
+ @echo ' ipf : Make OS/2 IPF documentation. (only the FCL and RTL)'
@echo ' hevea : Make HTML documentation using hevea'
@echo ' l2h : Make HTML documentation using latex2html'
@echo ' 4ht : Make HTML documentation using tex4ht'
@@ -279,7 +285,7 @@
clean:
-rm -f preamble.inc date.inc messages.inc rtl.inc
- -rm -f *.4tc *.4ct *.css *.lg *.tmp *.xref *.kwd *.xct *.chm
+ -rm -f *.4tc *.4ct *.css *.lg *.tmp *.xref *.kwd *.xct *.chm *.ipf
-rm -rf $(DOCS)
-rm -f $(CHK) $(TOC) $(LOG) $(DVI) $(PDF) $(AUX) $(OUT) $(PS) $(HTML) *.i* $(LOT) $(TXT)
# Styles
@@ -692,6 +698,9 @@
chm:
$(MAKE) html HTMLFMT=chm
+
+ipf:
+ $(MAKE) html HTMLFMT=ipf
endif # INSTALLDEBUG
#######################################################################
_______________________________________________
fpc-devel maillist - [email protected]
http://lists.freepascal.org/mailman/listinfo/fpc-devel
