Browse Source

+ Added fcl docs and fpdoc

michael 22 years ago
parent
commit
21d1414d26
3 changed files with 46 additions and 21 deletions
  1. 16 10
      docs/Makefile
  2. 28 9
      docs/fpc.sty
  3. 2 2
      docs/fpctoc.html

+ 16 - 10
docs/Makefile

@@ -22,7 +22,7 @@
 #INSTALLDEBUG=1
 
 # Which docs are made when 'html' is specified
-HTML = user units ref prog fpdoc
+HTML = user units ref prog fpdoc fcl
 
 # Can be 'report','book', 'html', 'hevea', 'ts3' 'ts4'
 ifdef USEHEVEA
@@ -44,7 +44,7 @@ ifndef DOCINSTALLDIR
 DOCINSTALLDIR:=$(PREFIXINSTALLDIR)/doc/fpc-$(shell ppc386 -iV)
 endif
 
-FPDOC=/home/michael/projects/fpdoc/fpdoc
+FPDOC=fpdoc
 
 # Use Ascii mode ? (i.e. no pics in produced HTML ?)
 ifndef ASCIIMODE
@@ -124,7 +124,6 @@ CHAPTERS = $(addsuffix .tex, crt dos getopts go32 graph linux printer\
              strings objects heaptrc sysutils ipc mouse gpm dxeload \
              emu387 ports math keyboard typinfo video)
 
-FCLCHAPTERS = $(addsuffix .tex, classes)
 
 GTKPDF=$(addsuffix .pdf,$(addprefix gtk, 1 2 3 4 5))
 
@@ -313,10 +312,10 @@ endif
 #####################################################################
 # Tex from XML
 #####################################################################
-FPCLASSESOPT=--package=fcl --descr=classes.xml --input='../fcl/linux/classes.pp -I../fcl/inc'
+FCLOPTS=--package=fcl --descr=classes.xml --input='../fcl/linux/classes.pp -Fi../fcl/inc'
 
-classes.tex: classes.xml
-	$(FPDOC) --output=. $(FPCLASSESOPT) --format=latex
+fcl.inc: classes.xml
+	$(FPDOC) --output=fcl.inc $(FCLOPTS) --format=latex
 
 #####################################################################
 # DVI files
@@ -334,6 +333,8 @@ user.dvi: user.tex includes
 
 fpdoc.dvi: fpdoc.tex includes
 
+fcl.dvi: fcl.tex fcl.inc includes
+
 units.pdf: units.tex includes $(CHAPTERS)
 
 ref.pdf: ref.tex includes
@@ -348,6 +349,8 @@ onechap.dvi: onechap.tex includes
 
 fpdoc.pdf: fpdoc.tex includes
 
+fcl.pdf: fcl.tex fcl.inc includes
+
 dvi : $(DVI)
 
 txt : dvi $(TXT)
@@ -394,10 +397,10 @@ l2h:
 4ht:
 	$(MAKE) html USETEX4HT=1
 
-classes: classes/index.html
+fcl: fcl/index.html
 
-classes/index.html: classes.xml
-	$(FPDOC) $(FPCLASSESOPT) --format=html
+fcl/index.html: classes.xml
+	$(FPDOC) $(FCLOPTS) --format=html --output=fcl
 
 #####################################################################
 # GTK Articles
@@ -540,7 +543,10 @@ execute:
 
 #
 # $Log$
-# Revision 1.20  2003-03-18 00:14:51  michael
+# Revision 1.21  2003-03-18 21:25:23  michael
+# + Added fcl docs and fpdoc
+#
+# Revision 1.20  2003/03/18 00:14:51  michael
 # + Added fpdoc
 #
 # Revision 1.19  2003/03/17 08:27:27  michael

+ 28 - 9
docs/fpc.sty

@@ -245,14 +245,29 @@
 %
 % For examples
 %
-\newcommand{\FPCexample}[1]{%
-    \par \file{\textbf{Listing:} \exampledir/#1.pp}%
-    \lstinputlisting{\exampledir/#1.pp}%
+\makeatletter
+\@ifpackageloaded{tex4ht}{%
+\newcommand{\FPCexample}[1]{
+\par \file{\textbf{Listing:} \exampledir/#1.pp}%
+\HCode{<HR/>}%
+\listinginput[9999]{5000}{\exampledir/#1.pp}%
+\HCode{<HR/>}%
+}%
+\newcommand{\Cexample}[1]{
+\par \file{\textbf{Listing:} \exampledir/#1.pp}%
+\listinginput[9999]{5000}{\exampledir/#1.c}%
 }
+}{% else ifpackageloaded
+\newcommand{\FPCexample}[1]{%
+\par \file{\textbf{Listing:} \exampledir/#1.pp}%
+\lstinputlisting{\exampledir/#1.pp}%
+}% End of FPCExample
 \newcommand{\Cexample}[1]{%
-    \par \file{\textbf{Listing:} \exampledir/#1.c}%
-    \lstinputlisting[language=c]{\exampledir/#1.c}%
-}
+\par \file{\textbf{Listing:} \exampledir/#1.c}%
+\lstinputlisting[language=c]{\exampledir/#1.c}%
+}% End of CExample
+}% End of ifpackageloaded.
+\makeatother
 \newcommand{\exampledir}{.}
 \newcommand{\FPCexampledir}[1]{\renewcommand{\exampledir}{#1}}
 %
@@ -293,15 +308,19 @@
 %
 % Set some listings options.
 %
-\latex{%
+\makeatletter
+\@ifpackageloaded{tex4ht}{%
+\usepackage{moreverb}
+}{%
   \usepackage{listings}%
   \lstset{language=Delphi}%
   \lstset{basicstyle=\sffamily\small}%
   \lstset{commentstyle=\itshape}%
   \lstset{keywordstyle=\bfseries}%
   \lstset{frame=tb}%
-%  \lstset{stringspaces=false}%
-}
+  \lstset{showstringspaces=false}%
+} 
+\makeatother
 %
 % Page settings
 \setlength{\oddsidemargin}{20pt}

+ 2 - 2
docs/fpctoc.html

@@ -8,9 +8,9 @@
 <UL>
 <LI> <A HREF="user/user.html">User's guide</A>.
 <LI> <A HREF="prog/prog.html">Programmer's guide</A>.
-<LI> <A HREF="ref/ref.html">Reference guide</A> for the system unit, and
-supported Pascal constructs.
+<LI> <A HREF="ref/ref.html">Reference guide</A> for the system unit, and supported Pascal constructs.
 <LI> <A HREF="units/units.html">Standard units reference manual</A>.
+<LI> <A HREF="fcl/index.html">Free Component Library reference manual</A>.
 <LI> <A HREF="fpdoc/fpdoc.html">Free Pascal documentation tool manual.</A>.
 </UL>
 <P>