Permalink
Browse files

Initial revision

  • Loading branch information...
0 parents commit eab1131e8b07ceef2187e7addc9128631497da96 @docelic docelic committed Jul 11, 2004
Showing with 9,230 additions and 0 deletions.
  1. +185 −0 Makefile
  2. +90 −0 README
  3. +194 −0 bin/dbgen
  4. +214 −0 bin/mkreport
  5. +195 −0 bin/pp
  6. +251 −0 bin/stattree
  7. BIN cache/cvs-head/.cache.bin
  8. +80 −0 cache/cvs-head/.objectlist.c.txt
  9. +1,842 −0 cache/cvs-head/.objectlist.perl.txt
  10. +3,916 −0 cache/cvs-head/.tags
  11. +19 −0 docbook/catalog.xml
  12. +25 −0 docbook/common.xsl
  13. +31 −0 docbook/docbookxi.dtd
  14. +20 −0 docbook/html-chunks.xsl
  15. +30 −0 docbook/html-common.xsl
  16. +15 −0 docbook/html-nochunks.xsl
  17. +18 −0 docbook/olinkdb.xml
  18. +56 −0 docbook/xmldocs.css
  19. +10 −0 files/tutorial-phase1/bottom
  20. +9 −0 files/tutorial-phase1/catalog.cfg
  21. +5 −0 files/tutorial-phase1/left
  22. +6 −0 files/tutorial-phase1/pages/index.html
  23. +25 −0 files/tutorial-phase1/permissions.txt
  24. +5 −0 files/tutorial-phase1/products/products.txt
  25. +11 −0 files/tutorial-phase1/top
  26. +10 −0 files/tutorial-phase2/bottom
  27. +9 −0 files/tutorial-phase2/catalog.cfg
  28. +5 −0 files/tutorial-phase2/left
  29. +9 −0 files/tutorial-phase2/pages/flypage.html
  30. +21 −0 files/tutorial-phase2/pages/index.html
  31. +5 −0 files/tutorial-phase2/products/products.txt
  32. +6 −0 files/tutorial-phase2/special_pages/missing.html
  33. +11 −0 files/tutorial-phase2/top
  34. +10 −0 files/tutorial-phase3/bottom
  35. +9 −0 files/tutorial-phase3/catalog.cfg
  36. +5 −0 files/tutorial-phase3/left
  37. +9 −0 files/tutorial-phase3/pages/flypage.html
  38. +24 −0 files/tutorial-phase3/pages/index.html
  39. +40 −0 files/tutorial-phase3/pages/ord/basket.html
  40. +5 −0 files/tutorial-phase3/products/products.txt
  41. +6 −0 files/tutorial-phase3/special_pages/missing.html
  42. +11 −0 files/tutorial-phase3/top
  43. +10 −0 files/tutorial-phase4/bottom
  44. +9 −0 files/tutorial-phase4/catalog.cfg
  45. +14 −0 files/tutorial-phase4/etc/profiles.order
  46. +14 −0 files/tutorial-phase4/etc/report
  47. +5 −0 files/tutorial-phase4/left
  48. +85 −0 files/tutorial-phase4/pages/checkout.html
  49. +9 −0 files/tutorial-phase4/pages/flypage.html
  50. +24 −0 files/tutorial-phase4/pages/index.html
  51. +40 −0 files/tutorial-phase4/pages/ord/basket.html
  52. +5 −0 files/tutorial-phase4/products/products.txt
  53. +6 −0 files/tutorial-phase4/special_pages/missing.html
  54. +10 −0 files/tutorial-phase4/special_pages/needfield.html
  55. +5 −0 files/tutorial-phase4/special_pages/receipt.html
  56. +11 −0 files/tutorial-phase4/top
  57. +10 −0 files/tutorial-phase5/bottom
  58. +27 −0 files/tutorial-phase5/catalog.cfg
  59. +14 −0 files/tutorial-phase5/etc/profiles.order
  60. +14 −0 files/tutorial-phase5/etc/report
  61. +17 −0 files/tutorial-phase5/left
  62. +123 −0 files/tutorial-phase5/pages/checkout.html
  63. +9 −0 files/tutorial-phase5/pages/flypage.html
  64. +24 −0 files/tutorial-phase5/pages/index.html
  65. +40 −0 files/tutorial-phase5/pages/ord/basket.html
  66. +38 −0 files/tutorial-phase5/pages/results.html
  67. +5 −0 files/tutorial-phase5/products/products.txt
  68. +6 −0 files/tutorial-phase5/special_pages/missing.html
  69. +10 −0 files/tutorial-phase5/special_pages/needfield.html
  70. +5 −0 files/tutorial-phase5/special_pages/receipt.html
  71. +11 −0 files/tutorial-phase5/top
  72. +1,150 −0 guides/iccattut.xml
  73. +5 −0 images/.xvpics/end-example.png
  74. +5 −0 images/.xvpics/end-example.xcf
  75. BIN images/.xvpics/example.png
  76. BIN images/.xvpics/example.xcf
  77. BIN images/.xvpics/example2.png
  78. BIN images/.xvpics/example2.xcf
  79. +23 −0 images/.xvpics/icon_ic2.png
  80. BIN images/1.png
  81. BIN images/10.png
  82. BIN images/2.png
  83. BIN images/3.png
  84. BIN images/4.png
  85. BIN images/5.png
  86. BIN images/6.png
  87. BIN images/7.png
  88. BIN images/8.png
  89. BIN images/9.png
  90. BIN images/caution.png
  91. BIN images/end-example.png
  92. BIN images/end-example.xcf
  93. BIN images/example.png
  94. BIN images/example.xcf
  95. BIN images/example2.png
  96. BIN images/example2.xcf
  97. BIN images/home.png
  98. BIN images/icon_ic.png
  99. BIN images/icon_ic2.png
  100. BIN images/important.png
  101. BIN images/interch-logo1.png
  102. BIN images/interch-logo1.xcf
  103. BIN images/logo2.png
  104. BIN images/next.png
  105. BIN images/note.png
  106. BIN images/prev.png
  107. BIN images/tip.png
  108. BIN images/toc-blank.png
  109. BIN images/toc-minus.png
  110. BIN images/toc-plus.png
  111. BIN images/up.png
  112. BIN images/valid-css.png
  113. BIN images/valid-xhtml10.png
  114. BIN images/warning.png
185 Makefile
@@ -0,0 +1,185 @@
+#
+# ICDEVGROUP Documentation makefile
+# http://www.icdevgroup.org
+# http://www.icdevgroup.org/cgi-bin/cvsweb/xmldocs
+#
+
+# Base definitions
+SHELL = /bin/sh
+export OUTPUT = OUTPUT
+export CACHE = cache
+export XML_CATALOG_FILES = $(DOCBOOKDIR)/catalog.xml
+DOCBOOKDIR = docbook
+XSLT = xsltproc
+XSLT_FLAGS = --xinclude
+
+VPATH = guides
+
+## ## ##
+# Future updates (as documentation expands) go here:
+GUIDES = $(OUTPUT)/iccattut.html $(OUTPUT)/iccattut
+OLINKDBS_UNCHUNKED = $(DOCBOOKDIR)/iccattut-nochunks-targets.db
+OLINKDBS_CHUNKED = $(DOCBOOKDIR)/iccattut-chunks-targets.db
+
+BASE_OUTPUT = output-skel image-files support-files css
+TREE_STATS = tree-cache tree-reports
+# END
+## ## ##
+#
+# Plain "make" cleans up and builds everything. To invoke targets
+# manually, use names from the section above.
+#
+# The targets not autobuilt are tree-stats, tags and objlists. They generate
+# files in cache/. cache/ contains information derived from IC
+# releases.
+# When you want to re-generate the cache information (because say,
+# CVS update happends), make sure the "sources" directory or symlink
+# points to a directory with the release you wish to update (for
+# example, "cvs-head" or "5.2.0"), then run 'make cache'.
+# And don't forget to commit updated cache/ files (if any) to docs CVS.
+
+############## No need to modify below ##############
+
+
+.PHONY: $(BASE_OUTPUT) $(TREE_STATS) cache distclean clean FORCE
+
+all: distclean $(BASE_OUTPUT) $(TREE_STATS) \
+ $(OLINKDBS_UNCHUNKED) $(OLINKDBS_CHUNKED) \
+ $(GUIDES)
+
+#
+# XML documentation
+#
+#@echo GOT $*-shortname / $?-all prereqs / $@-output.html / $<-first prereq
+$(OUTPUT)/%.html: %.xml $(DOCBOOKDIR)/* OUTPUT
+ # Unchunked document
+ $(XSLT) $(XSLT_FLAGS) \
+ --stringparam current.docid $* \
+ --stringparam target.database.document ../$(DOCBOOKDIR)/olinkdb.xml \
+ -o $@ \
+ $(DOCBOOKDIR)/html-nochunks.xsl $<
+
+$(OUTPUT)/%: %.xml $(DOCBOOKDIR)/* OUTPUT
+ # Chunked document
+ $(XSLT) $(XSLT_FLAGS) \
+ --stringparam current.docid $* \
+ --stringparam target.database.document ../$(DOCBOOKDIR)/olinkdb.xml \
+ -o $@/ \
+ $(DOCBOOKDIR)/html-chunks.xsl $<
+
+#
+# OLink databases
+#
+$(DOCBOOKDIR)/%-nochunks-targets.db: %.xml
+ # Generate olink databases for unchunked html files
+ $(XSLT) $(XSLT_FLAGS) \
+ --stringparam collect.xref.targets only \
+ --stringparam targets.filename $@ \
+ $(DOCBOOKDIR)/html-nochunks.xsl \
+ $<
+
+$(DOCBOOKDIR)/%-chunks-targets.db: %.xml
+ # Generate olink databases for chunked html files
+ $(XSLT) $(XSLT_FLAGS) \
+ --stringparam collect.xref.targets only \
+ --stringparam targets.filename $@ \
+ $(DOCBOOKDIR)/html-chunks.xsl \
+ $<
+
+#
+# Support files
+#
+OUTPUT: $(BASE_OUTPUT)
+
+cache: tree-stats objlists tags
+
+objlists:
+ # Generate human-readable ctags information
+ cd sources; for p in *; do \
+ cd ..; \
+ ctags -R -x --languages=perl --perl-kinds=cls sources/$$p/ \
+ > $(CACHE)/$$p/.objectlist.perl.txt; \
+ ctags -R -x --languages=c --c-kinds=cdf sources/$$p/ \
+ > $(CACHE)/$$p/.objectlist.c.txt; \
+ cd sources \
+ ; done
+
+tags:
+ # Generate ctags information
+ cd sources; for p in *; do \
+ cd ..; \
+ ctags -f $(CACHE)/$$p/.tags -R --extra=fq --fields=afikKlmnsSz --line-directives sources/$$p; \
+ cd sources \
+ ; done
+
+tree-stats:
+ # Generate stats to bin dump
+ # Only do that when sources/ is populated
+ cd sources; for p in *; do \
+ cd ..; \
+ mkdir -p $(CACHE)/$$p; \
+ ./bin/stattree sources/$$p \
+ ; done
+
+tree-reports:
+ # Make report from $(OUTPUT)/<ver>/.cache.bin
+ cd cache; for p in *; do \
+ cd ..; \
+ mkdir -p $(CACHE)/$$p; \
+ ./bin/mkreport cache/$$p \
+ ; done
+
+tree-cache:
+ # Copy tree stats to $(OUTPUT)
+ for p in cache/*; do \
+ cp -a $$p $(OUTPUT) \
+ ; done
+
+output-skel:
+ # Mirror cache/ structure in output (actually, determine releases)
+ mkdir -p $(OUTPUT)
+ cd cache; for p in *; do \
+ mkdir -p ../$(OUTPUT)/$$p \
+ ; done
+ mkdir -p $(OUTPUT)/images
+ mkdir -p $(OUTPUT)/files
+
+image-files: $(OUTPUT)/images
+ # Images
+ #cp images/*.{png,gif,jpg,jpeg} $(OUTPUT)/images/
+ -cp images/*.png $(OUTPUT)/images/
+
+support-files:
+ # Copy support files
+ cp -a files/* $(OUTPUT)/files/
+ cp bin/dbgen $(OUTPUT)/files/
+ cd files; for p in *; do \
+ if test -d $$p; then \
+ tar cf ../$(OUTPUT)/files/$$p.tar $$p; \
+ tar zcf ../$(OUTPUT)/files/$$p.tgz $$p; \
+ tar jcf ../$(OUTPUT)/files/$$p.tbz2 $$p; \
+ fi \
+ ; done
+
+css:
+ # Copy css definitions
+ cp $(DOCBOOKDIR)/*.css $(OUTPUT)/
+
+#
+# sources/ directory related
+# TODO Make target that conveniently checks out all IC releases from CVS,
+# sets them in appropriate directories under cache/ and runs the tree
+# statistics generator.
+
+#
+#
+#
+distclean clean:
+ -rm -r $(OUTPUT)
+ -rm $(DOCBOOKDIR)/*.db
+ -for p in $(CACHE)/*; do \
+ rm $$p/* \
+ ; done
+
+FORCE: ;
+
90 README
@@ -0,0 +1,90 @@
+
+The Interchange Development Group
+http://www.icdevgroup.org
+
+ICDEVGROUP Documentation Set
+http://www.icdevgroup.org/cgi-bin/cvsweb/xmldocs/
+
+
+INTRODUCTION
+
+The (new) Interchange XML documentation set is completely self-contained.
+To build the complete documentation set, run:
+
+ make
+
+To build specific targets, see Makefile for target names.
+
+
+PREREQUISITES
+
+To perform a successful build, this programs and modules must be available:
+
+ - Perl
+ - Shell commands: mkdir, cp, tar, gzip, bzip2
+ - DocBook XML
+ - xsltproc
+
+
+FINAL OUTPUT
+
+During the invocation of 'make', few files will be created:
+
+ docbook/*.db - OLink DB files generated from source .xml files
+
+ cache/<ver>/* - Various Interchange source tree statistics, available
+ over a filesystem interface. (For XInclusion in .xml
+ sources and similar purposes). The files are generated
+ from cache/<ver>/.cache.bin.
+
+ OUTPUT/ - Autogenerated:
+ directory containing the actual completely self-contained
+ and interlinked documentation set. Once it's created, you
+ can move it out of the build tree and package as you see
+ fit.
+
+
+DEVELOPMENT NOTES
+
+
+ The directory structure:
+ Makefile - Main Makefile
+ bin - Helper tools
+ cache - Interchange source trees metadata
+ docbook - DocBook XML support files
+ files - Support files, such as examples etc.
+ guides - Collection of guides
+ howtos - Collection of howtos
+ refs - Collection of reference pages
+ images - All images
+ tmp - A scratch space and a kind of a pending/ directory.
+ If you have a chunk which you'd like to integrate in
+ the docset, but don't have the time to prepare it
+ yourself, just drop it in there and someone will pick
+ it up.
+
+
+ Updating cache/:
+ The dotfiles found in cache/ can only be generated when the sources/
+ directory is present, and contains Interchange releases in directories
+ named after release numbers (with the exception of "cvs-head").
+ (Or the "sources" file can be a symlink to the right location where
+ you keep such directory structure).
+
+ Once that's in place, run "make cache". This will regenerate files for
+ the versions you have.
+
+ As this is only rarely done (only when the release changes due to an
+ important backport or something - and even then it probably doesn't
+ change any figures because the updates are small), the generated files
+ *are* kept in the CVS because they can be considered static.
+
+
+ The XML "preprocessor" tool:
+ There's bin/pp tool which you can use to write XML more conveniently.
+ See the script itself for usage notes.
+
+
+
+Davor Ocelic, docelic@icdevgroup.org
+
Oops, something went wrong.

0 comments on commit eab1131

Please sign in to comment.