From 6ec2b7b42737cee4574c12c090fdb4a4655bd6aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Duval?= Date: Mon, 16 May 2005 10:01:15 +0000 Subject: [PATCH] added a haiku book template moved Shell_Tools in its own directory added a variable to set the output directory git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@12677 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- src/documentation/Jamfile | 17 ++-- src/documentation/haiku_book/Haiku_Book.xml | 80 +++++++++++++++++++ src/documentation/haiku_book/Jamfile | 27 +++++++ src/documentation/haiku_book/appkit.xml | 7 ++ src/documentation/haiku_book/devicekit.xml | 7 ++ src/documentation/haiku_book/gamekit.xml | 7 ++ src/documentation/haiku_book/interfacekit.xml | 7 ++ src/documentation/haiku_book/kernelkit.xml | 7 ++ src/documentation/haiku_book/mailkit.xml | 7 ++ src/documentation/haiku_book/mediakit.xml | 7 ++ src/documentation/haiku_book/midikit.xml | 7 ++ src/documentation/haiku_book/networkkit.xml | 7 ++ src/documentation/haiku_book/openglkit.xml | 7 ++ src/documentation/haiku_book/storagekit.xml | 7 ++ src/documentation/haiku_book/supportkit.xml | 7 ++ .../haiku_book/translationkit.xml | 7 ++ src/documentation/shell_tools/Jamfile | 13 +++ .../{ => shell_tools}/Shell_Tools-Guide.xml | 2 +- 18 files changed, 217 insertions(+), 13 deletions(-) create mode 100644 src/documentation/haiku_book/Haiku_Book.xml create mode 100644 src/documentation/haiku_book/Jamfile create mode 100644 src/documentation/haiku_book/appkit.xml create mode 100644 src/documentation/haiku_book/devicekit.xml create mode 100644 src/documentation/haiku_book/gamekit.xml create mode 100644 src/documentation/haiku_book/interfacekit.xml create mode 100644 src/documentation/haiku_book/kernelkit.xml create mode 100644 src/documentation/haiku_book/mailkit.xml create mode 100644 src/documentation/haiku_book/mediakit.xml create mode 100644 src/documentation/haiku_book/midikit.xml create mode 100644 src/documentation/haiku_book/networkkit.xml create mode 100644 src/documentation/haiku_book/openglkit.xml create mode 100644 src/documentation/haiku_book/storagekit.xml create mode 100644 src/documentation/haiku_book/supportkit.xml create mode 100644 src/documentation/haiku_book/translationkit.xml create mode 100644 src/documentation/shell_tools/Jamfile rename src/documentation/{ => shell_tools}/Shell_Tools-Guide.xml (97%) diff --git a/src/documentation/Jamfile b/src/documentation/Jamfile index cac93c1d48..b18757419d 100644 --- a/src/documentation/Jamfile +++ b/src/documentation/Jamfile @@ -9,26 +9,19 @@ rule Doc2HTML SEARCH on $(source) = $(SEARCH_SOURCE) ; - MakeLocate $(target) : [ FDirName $(OBOS_DISTRO_TARGET) beos documentation Shell\ Tools ] ; + MakeLocate $(target) : [ FDirName $(OBOS_DISTRO_TARGET) beos documentation $(DOC_LOCATION) ] ; Depends $(target) : $(source) ; LocalDepends doc_files : $(target) ; - XSLPROCPATHS on $(target) = $(XSLPATHS:J=\ ) ; + XSLPROCPATHS on $(target) = "-path \""$(XSLPATHS:J=\ )"\"" ; Doc2HTML1 $(target) : $(source) ; LocalClean clean : $(target) ; } actions Doc2HTML1 { - $(XSLTPROC) -xinclude -path "$(XSLPROCPATHS)" -o "$(1)" $(HTMLXSLSHEET) $(2) ; + $(XSLTPROC) -xinclude $(XSLPROCPATHS) -o "$(1)" $(HTMLXSLSHEET) $(2) ; } -XSLPATHS = [ FDirName $(OBOS_OBJECT_TARGET) documentation Shell_Tools ] [ FDirName $(OBOS_TOP) src bin coreutils man ] ; -HTMLXSLSHEET = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl ; - -Doc2HTML - Shell_Tools-Guide.xml - ; - -Includes [ FGristFiles Shell_Tools-Guide.xml ] : coreutils.xml ; -SEARCH on coreutils.xml = [ FDirName $(OBOS_TOP) src bin coreutils man ] ; +SubInclude OBOS_TOP src documentation haiku_book ; +SubInclude OBOS_TOP src documentation shell_tools ; diff --git a/src/documentation/haiku_book/Haiku_Book.xml b/src/documentation/haiku_book/Haiku_Book.xml new file mode 100644 index 0000000000..f7921252db --- /dev/null +++ b/src/documentation/haiku_book/Haiku_Book.xml @@ -0,0 +1,80 @@ + + + + + + + + + + + + + + + + + + + + + +Haiku'> + + +]> + + + + Haiku Book + 2005-05-16 + + Jerome + Duval + + + + + This guide is the documentation for the C and C++ API of &haiku;. + + + + + + 1.0 + 2005-05-16 + kor + Initial version. + + + + + + +&appkit; +&devicekit; +&gamekit; +&interfacekit; +&kernelkit; +&mailkit; +&mediakit; +&midikit; +&networkkit; +&openglkit; +&storagekit; +&supportkit; +&translationkit; + + +&license; + + diff --git a/src/documentation/haiku_book/Jamfile b/src/documentation/haiku_book/Jamfile new file mode 100644 index 0000000000..51a7a6fdce --- /dev/null +++ b/src/documentation/haiku_book/Jamfile @@ -0,0 +1,27 @@ +SubDir OBOS_TOP src documentation haiku_book ; + +XSLPATHS = ; +HTMLXSLSHEET = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl ; +DOC_LOCATION = Haiku\ Book ; + +Doc2HTML + Haiku_Book.xml + ; + +local chapter_files = appkit.xml +devicekit.xml +gamekit.xml +interfacekit.xml +kernelkit.xml +mailkit.xml +mediakit.xml +midikit.xml +networkkit.xml +openglkit.xml +storagekit.xml +supportkit.xml +translationkit.xml ; + +Includes [ FGristFiles Haiku_Book.xml ] + : [ FGristFiles $(chapter_files) ] license.xml ; +SEARCH on [ FGristFiles $(chapter_files) ] = [ FDirName $(OBOS_TOP) src documentation haiku_book ] ; diff --git a/src/documentation/haiku_book/appkit.xml b/src/documentation/haiku_book/appkit.xml new file mode 100644 index 0000000000..c1c6d6c038 --- /dev/null +++ b/src/documentation/haiku_book/appkit.xml @@ -0,0 +1,7 @@ + + + +The Application Kit + + + diff --git a/src/documentation/haiku_book/devicekit.xml b/src/documentation/haiku_book/devicekit.xml new file mode 100644 index 0000000000..15b230fbb8 --- /dev/null +++ b/src/documentation/haiku_book/devicekit.xml @@ -0,0 +1,7 @@ + + + +The Device Kit + + + diff --git a/src/documentation/haiku_book/gamekit.xml b/src/documentation/haiku_book/gamekit.xml new file mode 100644 index 0000000000..97933595c5 --- /dev/null +++ b/src/documentation/haiku_book/gamekit.xml @@ -0,0 +1,7 @@ + + + +The Game Kit + + + diff --git a/src/documentation/haiku_book/interfacekit.xml b/src/documentation/haiku_book/interfacekit.xml new file mode 100644 index 0000000000..567796dc06 --- /dev/null +++ b/src/documentation/haiku_book/interfacekit.xml @@ -0,0 +1,7 @@ + + + +The Interface Kit + + + diff --git a/src/documentation/haiku_book/kernelkit.xml b/src/documentation/haiku_book/kernelkit.xml new file mode 100644 index 0000000000..ef3e868870 --- /dev/null +++ b/src/documentation/haiku_book/kernelkit.xml @@ -0,0 +1,7 @@ + + + +The Kernel Kit + + + diff --git a/src/documentation/haiku_book/mailkit.xml b/src/documentation/haiku_book/mailkit.xml new file mode 100644 index 0000000000..3f771736e4 --- /dev/null +++ b/src/documentation/haiku_book/mailkit.xml @@ -0,0 +1,7 @@ + + + +The Mail Kit + + + diff --git a/src/documentation/haiku_book/mediakit.xml b/src/documentation/haiku_book/mediakit.xml new file mode 100644 index 0000000000..ff7767566d --- /dev/null +++ b/src/documentation/haiku_book/mediakit.xml @@ -0,0 +1,7 @@ + + + +The Media Kit + + + diff --git a/src/documentation/haiku_book/midikit.xml b/src/documentation/haiku_book/midikit.xml new file mode 100644 index 0000000000..7b0bff0223 --- /dev/null +++ b/src/documentation/haiku_book/midikit.xml @@ -0,0 +1,7 @@ + + + +The Midi Kit + + + diff --git a/src/documentation/haiku_book/networkkit.xml b/src/documentation/haiku_book/networkkit.xml new file mode 100644 index 0000000000..6f5d85c3d3 --- /dev/null +++ b/src/documentation/haiku_book/networkkit.xml @@ -0,0 +1,7 @@ + + + +The Network Kit + + + diff --git a/src/documentation/haiku_book/openglkit.xml b/src/documentation/haiku_book/openglkit.xml new file mode 100644 index 0000000000..4021d01201 --- /dev/null +++ b/src/documentation/haiku_book/openglkit.xml @@ -0,0 +1,7 @@ + + + +The OpenGL Kit + + + diff --git a/src/documentation/haiku_book/storagekit.xml b/src/documentation/haiku_book/storagekit.xml new file mode 100644 index 0000000000..3cb8f8570d --- /dev/null +++ b/src/documentation/haiku_book/storagekit.xml @@ -0,0 +1,7 @@ + + + +The Storage Kit + + + diff --git a/src/documentation/haiku_book/supportkit.xml b/src/documentation/haiku_book/supportkit.xml new file mode 100644 index 0000000000..a68b5994d4 --- /dev/null +++ b/src/documentation/haiku_book/supportkit.xml @@ -0,0 +1,7 @@ + + + +The Support Kit + + + diff --git a/src/documentation/haiku_book/translationkit.xml b/src/documentation/haiku_book/translationkit.xml new file mode 100644 index 0000000000..2a1944cfcd --- /dev/null +++ b/src/documentation/haiku_book/translationkit.xml @@ -0,0 +1,7 @@ + + + +The Translation Kit + + + diff --git a/src/documentation/shell_tools/Jamfile b/src/documentation/shell_tools/Jamfile new file mode 100644 index 0000000000..9db5b861ac --- /dev/null +++ b/src/documentation/shell_tools/Jamfile @@ -0,0 +1,13 @@ +SubDir OBOS_TOP src documentation shell_tools ; + +XSLPATHS = [ FDirName $(OBOS_OBJECT_TARGET) documentation Shell_Tools ] [ FDirName $(OBOS_TOP) src bin coreutils man ] ; +HTMLXSLSHEET = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl ; +DOC_LOCATION = Shell\ Tools ; + +Doc2HTML + Shell_Tools-Guide.xml + ; + +Includes [ FGristFiles Shell_Tools-Guide.xml ] : coreutils.xml license.xml ; +SEARCH on coreutils.xml = [ FDirName $(OBOS_TOP) src bin coreutils man ] ; + diff --git a/src/documentation/Shell_Tools-Guide.xml b/src/documentation/shell_tools/Shell_Tools-Guide.xml similarity index 97% rename from src/documentation/Shell_Tools-Guide.xml rename to src/documentation/shell_tools/Shell_Tools-Guide.xml index 9f8c551867..a8e9188680 100644 --- a/src/documentation/Shell_Tools-Guide.xml +++ b/src/documentation/shell_tools/Shell_Tools-Guide.xml @@ -22,7 +22,7 @@ - + Haiku'>