You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by sh...@apache.org on 2012/10/05 08:41:31 UTC
svn commit: r1394381 - in /xalan/c/trunk/xdocs: DoxyfileXalan-nograf
README.txt make-apiDocs-nograf.sh make-apiDocs.sh sources/xalan/builddocs.xml
Author: shathaway
Date: Fri Oct 5 06:41:30 2012
New Revision: 1394381
URL: http://svn.apache.org/viewvc?rev=1394381&view=rev
Log:
XALAN-C build documentation page - rewrite - simplified
Added:
xalan/c/trunk/xdocs/DoxyfileXalan-nograf
xalan/c/trunk/xdocs/make-apiDocs-nograf.sh (with props)
Modified:
xalan/c/trunk/xdocs/README.txt
xalan/c/trunk/xdocs/make-apiDocs.sh
xalan/c/trunk/xdocs/sources/xalan/builddocs.xml
Added: xalan/c/trunk/xdocs/DoxyfileXalan-nograf
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/DoxyfileXalan-nograf?rev=1394381&view=auto
==============================================================================
--- xalan/c/trunk/xdocs/DoxyfileXalan-nograf (added)
+++ xalan/c/trunk/xdocs/DoxyfileXalan-nograf Fri Oct 5 06:41:30 2012
@@ -0,0 +1,333 @@
+# FILE: DoxyfileXalan
+#
+# This file is automatically generated using DOXYWIZARD
+# to create web pages for the Apache XALAN-C project.
+#
+# Software Release Versions Used
+# doxygen version 1.71
+# graphviz version 2.26.3
+#
+# The apiDocs web pages are created by invoking the following command:
+# doxygen DoxyfileXalan
+#
+# After the web pages are created in directory ../build/docs/apiDocs/html/
+# you should copy the apache feather logo image into that directory.
+#
+# cp html/apiDocs/asf_logo_wide.gif ../build/docs/apiDocs/html
+#
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING = UTF-8
+PROJECT_NAME = "Xalan-C++ API"
+PROJECT_NUMBER =
+OUTPUT_DIRECTORY = ../build/docs/apiDocs
+CREATE_SUBDIRS = NO
+OUTPUT_LANGUAGE = English
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+ALWAYS_DETAILED_SEC = NO
+INLINE_INHERITED_MEMB = NO
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH =
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = YES
+QT_AUTOBRIEF = NO
+MULTILINE_CPP_IS_BRIEF = NO
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE = 8
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+OPTIMIZE_FOR_FORTRAN = NO
+OPTIMIZE_OUTPUT_VHDL = NO
+EXTENSION_MAPPING =
+BUILTIN_STL_SUPPORT = NO
+CPP_CLI_SUPPORT = NO
+SIP_SUPPORT = NO
+IDL_PROPERTY_SUPPORT = YES
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+TYPEDEF_HIDES_STRUCT = NO
+SYMBOL_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = NO
+EXTRACT_STATIC = NO
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = NO
+EXTRACT_ANON_NSPACES = NO
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = YES
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = YES
+FORCE_LOCAL_INCLUDES = NO
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = YES
+SORT_BRIEF_DOCS = NO
+SORT_MEMBERS_CTORS_1ST = NO
+SORT_GROUP_NAMES = NO
+SORT_BY_SCOPE_NAME = NO
+GENERATE_TODOLIST = YES
+GENERATE_TESTLIST = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+SHOW_DIRECTORIES = NO
+SHOW_FILES = YES
+SHOW_NAMESPACES = YES
+FILE_VERSION_FILTER =
+LAYOUT_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = ../src/xalanc \
+ ../src/xalanc/Utils/MsgCreator \
+ ../src/xalanc/Utils/XalanMsgLib \
+ ../src/xalanc/XalanExtensions \
+ ../src/xalanc/Harness \
+ ../src/xalanc/TestXSLT \
+ ../src/xalanc/XalanSourceTree \
+ ../src/xalanc/XSLT \
+ ../src/xalanc/NLS \
+ ../src/xalanc/Include \
+ ../src/xalanc/XalanTransformer \
+ ../src/xalanc/ICUBridge \
+ ../src/xalanc/DOMSupport \
+ ../src/xalanc/PlatformSupport \
+ ../src/xalanc/TestXPath \
+ ../src/xalanc/XalanExe \
+ ../src/xalanc/XPathCAPI \
+ ../src/xalanc/XalanDOM \
+ ../src/xalanc/XercesParserLiaison \
+ ../src/xalanc/XercesParserLiaison/Deprecated \
+ ../src/xalanc/XalanEXSLT \
+ ../src/xalanc/XMLSupport \
+ ../src/xalanc/XPath
+INPUT_ENCODING = UTF-8
+FILE_PATTERNS = *.hpp \
+ *.h
+RECURSIVE = NO
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS =
+EXCLUDE_SYMBOLS =
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS = *
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH =
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = YES
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = NO
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION = NO
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS = NO
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 3
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = html
+HTML_FILE_EXTENSION = .html
+HTML_HEADER = html/apiDocs/header-local.html
+HTML_FOOTER = html/apiDocs/footer.html
+HTML_STYLESHEET =
+HTML_COLORSTYLE_HUE = 220
+HTML_COLORSTYLE_SAT = 100
+HTML_COLORSTYLE_GAMMA = 80
+HTML_TIMESTAMP = YES
+HTML_ALIGN_MEMBERS = NO
+HTML_DYNAMIC_SECTIONS = NO
+GENERATE_DOCSET = NO
+DOCSET_FEEDNAME = "Doxygen generated docs"
+DOCSET_BUNDLE_ID = org.doxygen.Project
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+DOCSET_PUBLISHER_NAME = Publisher
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+CHM_INDEX_ENCODING =
+BINARY_TOC = NO
+TOC_EXPAND = NO
+GENERATE_QHP = NO
+QCH_FILE =
+QHP_NAMESPACE = org.doxygen.Project
+QHP_VIRTUAL_FOLDER = doc
+QHP_CUST_FILTER_NAME =
+QHP_CUST_FILTER_ATTRS =
+QHP_SECT_FILTER_ATTRS =
+QHG_LOCATION =
+GENERATE_ECLIPSEHELP = NO
+ECLIPSE_DOC_ID = org.doxygen.Project
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = NO
+USE_INLINE_TREES = NO
+TREEVIEW_WIDTH = 250
+EXT_LINKS_IN_WINDOW = NO
+FORMULA_FONTSIZE = 10
+FORMULA_TRANSPARENT = YES
+SEARCHENGINE = NO
+SERVER_BASED_SEARCH = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = YES
+USE_PDFLATEX = YES
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+LATEX_SOURCE_CODE = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = NO
+MSCGEN_PATH =
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = NO
+DOT_NUM_THREADS = 0
+DOT_FONTNAME = FreeSans.ttf
+DOT_FONTSIZE = 10
+DOT_FONTPATH =
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+GROUP_GRAPHS = YES
+UML_LOOK = NO
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
+DOT_IMAGE_FORMAT = png
+DOT_PATH =
+DOTFILE_DIRS =
+DOT_GRAPH_MAX_NODES = 80
+MAX_DOT_GRAPH_DEPTH = 0
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
Modified: xalan/c/trunk/xdocs/README.txt
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/README.txt?rev=1394381&r1=1394380&r2=1394381&view=diff
==============================================================================
--- xalan/c/trunk/xdocs/README.txt (original)
+++ xalan/c/trunk/xdocs/README.txt Fri Oct 5 06:41:30 2012
@@ -1,146 +1,96 @@
XALAN-C++ USER GUIDE DEVELOPER NOTES
-Edited: 2012-09-16
-UNIX platforms can make both the xalan-c API document and the xalan-c website.
+Edited: 2012-10-05
-WINDOWS platforms can only make the xalan-c website without the xalan-C apiDocs.
+The html documentation pages are available on our website.
-Java and the Apache StyleBook program are no longer reuired.
-The XML transformations are now done using a standard XSLT
-command-line stylesheet transformation utility. The Apache Xalan
-program or Xalan.exe program is used for this transformation.
-The resulting web pages have static content without any javascript
-or other scripting requirements.
+ http://xalan.apache.org/xalan-c/index.html
-The resulting web pages scale well with a wide variety of web browsers.
-The browsers should support xhtml version 1.0. Even thou the pages
-are rendered as strict, the productions accommodate most browsers that
-only render the loose or transitional implementation.
+The html documentation pages can be built from the Xalan-C
+source distribution. Let ${XALANC} indicate the top directory
+of the source distribution.
-Download the source package from repository or subversion
+ ${XALANC}/src/ = the program library source files
+ ${XALANC}/xdocs/ = the program documentation source files
+ ${XALANC}/build/docs/ = the directory created for documentation builds
+ ${XALANC}/build/docs/apiDocs/html/ = apiDocs created here, then moved
+ ${XALANC}/build/docs/xalan-c/ = the html documentation tree
- http://www.apache.org/dyn/closer/xalan/xalan-c
- http://svn.apache.org/repos/asf/xalan/c/trunk
+#Setup UNIX for building the documents
-The documentation products will be built to the target directories
+1. Requires the "Xalan" executable in the ${PATH} environment.
- c/trunk/build/docs/apiDocs
- c/trunk/build/docs/xalan-c
+2. Requires the libxerces-c.so and libxalan-c.so libraries in a path
+ that is accessable to the "Xalan" executable.
-UNIX Build xalan-c apiDocs
+3. Requires a current installation of the Doxygen package.
- Prerequisite: The Doxygen package must be installed (doxygen) program.
- Prerequisite: The GraphViz package must be installed (dot) program.
+4. The interactive graphics for apiDocs require the GraphViz (dot) package.
- cd {c/trunk/xdocs}
- Edit the "make-apiDocs.sh" script
+#Build the documentation on UNIX
- Run the "make-apiDocs.sh" script
+1. Connect to the ${XALANC}/xdocs/ directory
-UNIX Build xalan-c website pages
+2. Run the make-apiDocs.sh (full graphics) or make-apiDocs-nograf (no graphics).
- Prerequisite: The "Xalan" command-line executable must be available
+3. The script automatically chains to ${XALANC}/xdocs/sources/make-book.sh
+ for building the remainder of the documentation.
- cd {c/trunk/xdocs/sources}
- Run the "make-book.sh" script
+4. You can now relocate and package the documentation at
+ ${XALNAC}/build/docs/xalan-c/ to your final destination of choice.
-WINDOWS Build the xalan-c website pages
+#Setup WINDOWS for building the documents
- Prerequisite: The "xalan.exe" command-line executable must be available
+1. Create a %XALANC%\bin\ directory. Then copy the xalan.exe and the DLL
+ libraries for xerces-c and xalan-c into that directory. This is where
+ the make-xalan.bat file expects to find the xalan.exe executable.
- cd {c/trunk/xdocs/sources}
- Run the "make-book.bat" script
+2. Connect to the %XALANC%\xdocs\sources\ directory.
--------------------------------------------------------------------
-The "sbk:" prefix is non-standard and was recognized by the deprecated
-Apache Stylebook Java program. The "sbk:" prefix has now been replaced
-with relative URLs for use with a standard XSLT stylesheet processor.
+3. Run the make-book.bat script to create the %XALANC%\build\docs\xalan-c\
+ documentation.
-MANIFEST
+4. You can now relocate and package the documentation at
+ %XALANC%\build\docs\xalan-c\ to your final destination of choice.
- {xalan/c/trunk}
+Note: WINDOWS has no Doxygen program for building the apiDocs.
+Building apiDocs requires a Linux or UNIX platform. You might
+be able to use WINDOWS JavaDocs to get an interactive apiDocs reference.
- bin/
- Placeholder for Xalan.exe and DLL files for Windows Binary executables.
+#About the StyleBook XML Markup
- build/
- Placeholder where products are constructed.
+The obsolete Apache Java Stylebook program is no longer being used.
+The StyleBook XML markup has been slightly modified to accommodate
+standard XSLT stylesheet transformations.
- build/docs/appDocs/
- Placeholder for construction of xalan-c apiDocs.
+## Source Directory Layout
- build/docs/xalan-c/
- Placeholder for construction of xalan-c webpages.
+ ${XALAN}/xdocs/style/dtd/* -- the validation DTD definitions
+ ${XALAN}/xdocs/sources/stylebook.xslt -- the XML StyleBook transform
+ ${XALAN}/xdocs/sources/xalan/* -- the StyleBook XML page content
+ ${XALAN}/xdocs/sources/xalan-graphic/* -- page specific graphics
+ ${XALAN}/xdocs/sources/xslt-resources/* -- logos and css stylesheets
+ ${XALAN}/xdocs/sources/xalan.xml -- the book navigation panel
+ ${XALAN}/xdocs/sources/entities.ent -- book XML general entity definitions
+ ${XALAN}/xdocs/sources/xalan/resources.xml -- general resource links
- src/
- Source tree of C/C++ sources for making the xalan library and
- Xalan command-line processor. The *.hpp source files contain
- the structured components from which the apiDocs document is
- constructed.
+The resulting document from "stylebook.xslt" is strict XHTML with
+markup rules that can also be supported on transitional browsers.
+To guard against XML element collapse, we use the Unicode
+zero-width-non-joining character to provide non-empty content.
+This is not enforced by the "stylebook.xslt" transform. The
+StyleBook XML sources should guard against unwanted element collapse.
- xdocs/
- Directory tree of documentation sources and build scripts.
+## Document Building Scripts
- xdocs/DoxyfileXalan The configuration file for doxygen program.
-
-* xdocs/make-apiDocs.sh The Bourne shell script to build apiDocs.
-
- xdocs/html/apiDocs/
- Directory of doxygen include files and Apache feather logo
- for apiDocs pages.
-
- xdocs/style/dtd/ The Stylebook validation DTD files.
-
- xdocs/sources/
- Directory tree of sources and scripts to build the xalan-c
- webpages or User Guide.
-
- xdocs/sources/entities.ent
- Some included DTD entity definitions.
-
- xdocs/sources/xalan-xml
- The Stylebook XML page navigation source.
-
- xdocs/sources/stylebook.xslt
- The standardized Xalan stylebook transformation stylesheet.
-
- xdocs/sources/xalan/
- Directory of Stylebook XML page sources for xalan-c User Guide.
-
- xdocs/sources/xalan-graphic/
- Special graphics required by some xdocs/sources/xalan/ sources.
- These files are copied to build/docs/xalan-c/
-
- xdocs/sources/xslt-resources/
- The Xalan LOGOs and css stylesheets for rendering web pages.
- These files are copied to build/docs/xalan-c/resources/
-
-* xdocs/sources/make-book.sh
- The UNIX Bourne shell script to build the xalan-c web pages.
-
-* xdocs/sources/make-book.bat
- The Windows command script to build the xalan-c web pages.
-
--------------------------------------------------------------------
-The Xalan-C website is published to "svnpubsub" by copying
-
- build/docs/xalan-c/*
-
-to the "svnpubsub" repository tree
-
- {svn}/xalan/site/docs/xalan/xalan-c/
-
-then perform a repository subversion check-in.
--------------------------------------------------------------------
-
-These notes are provided by Steven J. Hathaway for the
-Xalan Documentation Project.
-
-Current information is available on the Xalan website
-http://xalan.apache.org/xalan-c
+ ${XALAN}/xdocs/sources/make-xalan.sh {pagename} -- transform a single page
+ ${XALAN}/xdocs/sources/make-xalan.bat {pagename} -- transform a single page
+ ${XALAN}/xdocs/sources/make-book.sh -- transform an entire book
+ ${XALAN}/xdocs/sources/make-book.bat -- transform an entire book
+
Added: xalan/c/trunk/xdocs/make-apiDocs-nograf.sh
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/make-apiDocs-nograf.sh?rev=1394381&view=auto
==============================================================================
--- xalan/c/trunk/xdocs/make-apiDocs-nograf.sh (added)
+++ xalan/c/trunk/xdocs/make-apiDocs-nograf.sh Fri Oct 5 06:41:30 2012
@@ -0,0 +1,74 @@
+#!/bin/sh
+#
+# Script file to create Xalan-C apiDocs
+#
+# This script requires current versions of "Doxygen" and
+# "GraphViz (dot)" programs to be installed on your UNIX.
+#
+
+# Various OS's have different ways of specifying the library path
+#
+# Solaris and Linux
+# LD_LIBRARY_PATH=/usr/local/lib
+#
+# HP-UX
+# SHLIB_PATH=/usr/local/lib
+#
+# AIX and BSD
+# LIBPATH=/usr/local/lib
+#
+# Mac OS X
+# DYLD_LIBRARY_PATH=/usr/local/lib
+#
+# Cygwin and MinGW
+# PATH=
+#
+
+# Add the current directory to the PATH for nested scripts
+
+PATH=$PATH:.
+
+# Add the PATH for the Xalan program
+
+# export PATH=/usr/local/bin:$PATH
+
+# Make the necessary target paths
+
+if [ ! -d ../build/docs/apiDocs ] ; then
+ mkdir -p ../build/docs/apiDocs
+fi
+if [ ! -d ../build/docs/xalan-c ] ; then
+ mkdir -p ../build/docs/xalan-c
+fi
+
+# Create the xalan-c apiDocs using (doxygen) only.
+
+doxygen DoxyfileXalan-nograf
+
+# We may not want the many *.md5 files
+
+rm ../build/docs/apiDocs/html/*.md5
+
+# Copy the Apache Trademark Graphic
+
+cp html/apiDocs/asf_logo_wide.gif ../build/docs/apiDocs/html
+
+# Move the apiDocs to the xalan-c website tree
+
+if [ -e ../build/docs/xalan-c/apiDocs ] ; then
+ rm -rf ../build/docs/xalan-c/apiDocs
+fi
+mv ../build/docs/apiDocs/html ../build/docs/xalan-c/apiDocs
+
+#
+# Done with xalan-c apiDocs build
+#
+
+#
+# Chain to sources to create xalan-c website pages
+#
+
+cd sources
+make-book.sh
+cd ..
+
Propchange: xalan/c/trunk/xdocs/make-apiDocs-nograf.sh
------------------------------------------------------------------------------
svn:executable = *
Modified: xalan/c/trunk/xdocs/make-apiDocs.sh
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/make-apiDocs.sh?rev=1394381&r1=1394380&r2=1394381&view=diff
==============================================================================
--- xalan/c/trunk/xdocs/make-apiDocs.sh (original)
+++ xalan/c/trunk/xdocs/make-apiDocs.sh Fri Oct 5 06:41:30 2012
@@ -30,7 +30,7 @@ PATH=$PATH:.
# Add the PATH for the Xalan program
-export PATH=/usr/local/bin:$PATH
+# export PATH=/usr/local/bin:$PATH
# Make the necessary target paths
Modified: xalan/c/trunk/xdocs/sources/xalan/builddocs.xml
URL: http://svn.apache.org/viewvc/xalan/c/trunk/xdocs/sources/xalan/builddocs.xml?rev=1394381&r1=1394380&r2=1394381&view=diff
==============================================================================
--- xalan/c/trunk/xdocs/sources/xalan/builddocs.xml (original)
+++ xalan/c/trunk/xdocs/sources/xalan/builddocs.xml Fri Oct 5 06:41:30 2012
@@ -19,310 +19,142 @@
<!DOCTYPE s1 SYSTEM "../../style/dtd/document.dtd">
<s1 title="Building The Documents">
-
<ul>
-<li><link anchor="buildweb">Building the Xalan-C Web Pages</link></li>
+<li><link anchor="thedocs">The Xalan-C/C++ HTML Documentation</link></li>
+<li><link anchor="unixsetup">Setup UNIX for Building the Documents</link></li>
<ul>
- <li><link anchor="b_web_1">Documentation Source Tree</link></li>
- <li><link anchor="b_web_2">Destination Build Tree</link></li>
- <li><link anchor="b_web_3">The Web Page Build Environment</link></li>
- <li><link anchor="b_web_4">Preparing the Navigation File</link></li>
- <li><link anchor="b_web_5">Creating the Web Pages</link></li>
+ <li><link anchor="unixdocbld">Build the Documentation on UNIX</link></li>
</ul>
-<li><link anchor="buildapi">Building the Xalan-C API Reference</link></li>
+<li><link anchor="winsetup">Setup WINDOWS for Building the Documents</link></li>
+<li><link anchor="aboutstylebook">About the StyleBook XML Markup</link></li>
<ul>
- <li><link anchor="b_api_1">API Configuration Source Tree</link></li>
- <li><link anchor="b_api_2">Destination Path for API Web Pages</link></li>
- <li><link anchor="b_api_3">Build the API Web Pages</link></li>
+ <li><link anchor="sb_dirlayout">Source Directory Layout</link></li>
+ <li><link anchor="sb_scripts">Document Building Scripts</link></li>
</ul>
-<li><link anchor="integrateapi">Integrate API With Xalan-C Project Web Pages</link></li>
</ul>
-
-<anchor name="buildweb"/>
-<s2 title="Building the Xalan-C Web Pages">
-
-<p>This section shows how to build the documentation products for Xalan-C/C++.
-This is a subproject of the ASF XALAN PMC.
-</p>
-<p>The XALAN PMC project web page [<jump
-href="http://xalan.apache.org">http://xalan.apache.org</jump>] is a top-level page
-with branches to the subprojects that include the Java and C/C++ code libraries.
-</p>
-<p>The Xalan-C/C++ home web page [<jump
-href="../old/xalan-c">http://xml.apache.org/xalan-c</jump>]
-is the content
-construction that is being described here.
-</p>
-<p>The Apache StyleBook Java program is no longer needed to create useful web pages.
-You should have a standard XSLT transform utility.
-The "Xalan" command-line program distributed with Xalan-C works just fine.
-</p>
-
-<anchor name="b_web_1"/>
-<s3 title="Documentation Source Tree">
-
-<source>
-xalan/c/trunk/xdocs/sources/
- entities.ent -- Product specific entities
- make-book.bat -- Build All Web Pages
- make-xalan.bat -- Build Single Web Page
- xalan-book.xslt -- Transformation for StyleBook XML
- xalan.xml -- The Navigation Panel for Xalan-C Pages
-
-xalan/c/trunk/xdocs/sources/xslt-resources/
- {Common components used by Xalan-C Web Pages}
- apache-xalan.css -- The Web Page Presentation Style
- asf_logo.png -- The ASF Trademark Logo
- note.gif -- A (note:) graphic
-
-xalan/c/trunk/xdocs/sources/xalan/
- {The StyleBook XML Sources for Xalan-C Web Pages}
- index.xml -- This creates the root index.html
- resources.xml -- A resources dispatch page
-
-xalan/c/trunk/xdocs/style/dtd/
- {Resources for Apache StyleBook Validation}
- blocks.ent
- book.dtd
- changes.dtd
- characters.ent
- document.dtd
- faqs.dtd
- links.ent
- markup.ent
-</source>
-</s3>
-
-<anchor name="b_web_2"/>
-<s3 title="Destination Build Tree">
-
-<source>
-xalan/c/trunk/build/docs/html/
- {The Xalan-C project html Web Pages go here}
- index.html -- This is the root of the Xalan-C subproject
-
-xalan/c/trunk/build/docs/html/resources/
- {Resources to support Xalan-C project html Web Pages}
- apache-xalan.css
- asf_logo.png
- note.gif
-
-xalan/c/trunk/build/docs/html/apiDocs/
- {The Xalan-C API Web Pages go here}
- index.html -- This is the root of the Xalan-C API Documents
-</source>
-</s3>
-
-<anchor name="b_web_3"/>
-<s3 title="The Web Page Build Environment">
-
-<p>The examples here describe how to build the Xalan-C/C++ web pages when
-connected to the a copy of the (xdocs/sources) directory. So connect to it.
-</p>
-<p>The StyleBook DTD validation files are in the (xdocs/style/dtd) directory.
-</p>
-<p>The StyleBook XML sources for the web pages are in the (xdocs/sources/xalan) directory. Each web page is associated with an XML file in this directory. The transformed output is to be placed in the (build/docs/html) directory. The source XML file and the destination HTML file have the same base filename.
-</p>
-<p>The Web Page output directory is (build/docs/html).
-</p>
-<p>After creating the web pages, copy the (xdocs/sources/xslt-resources/*) files to the (build/docs/html/resources) directory.
-</p>
-<p>Graphic images for individual web pages are in the (xdocs/xalan-graphic) directory and later copied to the (build/docs/html) directory.
-</p>
-</s3>
-
-<anchor name="b_web_4"/>
-<s3 title="Preparing the Navigation File">
-
-<p>The (xdocs/sources/xalan.xml) is the project navigation file that is on
-the left side of each web page.
-The root element is <book>
-containing child elements of <hidden>, <external>,
-<document>, <resources>, <faqs>, and <separator>. The format of this navigation file is inherited from the StyleBook Java program. Our stylesheet uses the <book> to provide only a navigation panel. It does not control the production of the entire suite of web pages.
-</p>
-<p>The markup is validated by DTD and entity definitions in the (xdocs/style/dtd) directory.
-</p>
-<p>The "id=" attribute is the name of the web page file without extension.
-</p>
-<p>The "label=" attribute is the navigation text.
-</p>
-<p>The "source=" attribute is the name of the StyleBook XML source file.
-</p>
-<p>The "href=" attribute is a link to an external resource.
-</p>
-</s3>
-
-<anchor name="b_web_5"/>
-<s3 title="Creating the Web Pages">
-
-<p>The XSLT transformation utility must support top-level parameters.
-The <code>Xalan</code> command-line program built and distributed with the this project
-has sufficient capability to create the project web pages.
-The <code>xalan-book.xslt</code> stylesheet is designed to interpret StyleBook XML and create XHTML web pages for the Xalan-C project.
-</p>
-<p>Example: Create the <code>index.html</code> web page from <code>index.xml</code> source. The arguments are shown on separate lines for convenience of presentation.
-</p>
-<source>
-Xalan.exe
- -p sectionid "'index'"
- -p createdate "'Tue 08/09/2011'"
- xalan\index.xml
- xalan-book.xslt
- > ..\..\build\docs\html\index.html
-</source>
-
-<p>Do the same for each web page replacing <code>index</code>,
-<code>index.xml</code>, and <code>index.html</code> in the above example.
-</p>
-<p>Other command-line XSLT processors would have a different calling syntax.
-Check your documentation.</p>
-<p>I use batch files or shell scripts to automate this process.
-The following batch files are what I use on Windows platforms.
-</p>
-<p>The <code>make-book.bat</code> file is used to create all web pages:
-</p>
-<source>
- mkdir ..\..\build\docs\html\resources
-
- call make-xalan usagepatterns
- call make-xalan samples
- call make-xalan resources
- call make-xalan install
- call make-xalan download
- call make-xalan overview
- call make-xalan charter
- call make-xalan whatsnew
- call make-xalan extensionslib
- call make-xalan commandline
- call make-xalan readme
- call make-xalan releasenotes
- call make-xalan programming
- call make-xalan getstarted
- call make-xalan index
- call make-xalan extensions
- call make-xalan faq
- call make-xalan license
- call make-xalan buildlibs
- call make-xalan secureweb
-
- copy xalan-graphic\*.* ..\..\build\docs\html
- copy xslt-resources\*.* ..\..\build\docs\html\resources
-</source>
-
-<p>The <code>make-xalan.bat</code> file to create a single web page:
-</p>
-<source>
- ::
- :: Set the current path to include a stylesheet transformation utility
- ::
- :: %1 The document filename (without extension) to transform
- ::
- :: %XALANEXSLT% The exslt stylesheet transformation utility
- ::
- :: %XALANSTYLE% The XSLT stylesheet to convert STYLEBOOK markup
- ::
- :: %XALANXMLDIR% Source directory of STYLEBOOK markup XML documents
- ::
- :: %XALANOUTDIR% Target directory of XHTML web page documents
- ::
- :: %WEBCREATED% Web Page Creation Date
- ::
- :: sectionid Top-level stylesheet parameter (document file id)
- ::
- :: createdate Top-level stylesheet parameter (web page creation date)
- ::
-
- SET WEBCREATED=%DATE%
- SET XALANEXSLT=..\..\bin\xalan.exe
- SET XALANSTYLE=xalan-book.xslt
- SET XALANXMLDIR=xalan
- SET XALANOUTDIR=..\..\build\docs\html
-
- "%XALANEXSLT%" -p sectionid "'%1'" -p createdate "'%WEBCREATED%'" \
- %XALANXMLDIR%\%1.xml %XALANSTYLE% >% XALANOUTDIR%\%1.html
-</source>
-</s3>
+<p>Our HTML web page construction does not use or require
+any Java installed or the use of JavaScript.</p>
+<!-- END OF TOP-PAGE NAVIGAITON -->
+<anchor name="thedocs"/>
+<s2 title="The Xalan-C/C++ HTML Documentation">
+<p>The current Xalan-C/C++ HTML documentation pages are available on our website
+ <jump href="http://xalan.apache.org/xalan-c/index.html">
+ http://xalan.apache.org/xalan-c</jump>.</p>
+<p>The HTML documentation pages can be built from the Xalan-C
+source distribution. Let <code>${XALANC}</code> indicate the top directory
+of the source distribution.</p>
+<source>
+ ${XALANC}/src/ = the program library source files
+ ${XALANC}/xdocs/ = the program documentation source files
+ ${XALANC}/build/docs/ = the directory created for documentation builds
+ ${XALANC}/build/docs/apiDocs/html/ = apiDocs created here, then moved
+ ${XALANC}/build/docs/xalan-c/ = the HTML documentation tree
+</source>
+<p>UNIX platforms can build the complete documentation package (web pages plus
+interactive api reference).</p>
+<p> Windows platforms an only build the basic web pages.</p>
</s2>
-
-<anchor name="buildapi"/>
-<s2 title="Building the Xalan-C API Reference">
-
-<p>This section shows how to build the Xalan-C/C++ application program interface (API) documents using the <jump href="http://www.doxygen.org">Doxygen</jump> and
-<jump href="http://www.graphviz.org">GraphViz</jump> programs. These required software packages are available for most Unix systems.
-</p>
-
-<anchor name="b_api_1"/>
-<s3 title="API Configuration Source Tree">
-
-<source>
-xalan/c/trunk/src/xalanc/ -- [*.h, *.hpp] source code files
-
-xalan/c/trunk/xdocs/
- DoxyfileXalan -- The doxygen configuration file
-
-xalan/c/trunk/xdocs/html/apiDocs/
- asf_logo_wide.gif -- The wide ASF trademark logo
- footer.html -- The footer html fragment for copyright
- header.html -- Header html fragment for document title
- header-local.html -- Header html fragment for optional title
-</source>
-
-<p>Note: (ApacheLogo.jpg) is replaced with (asf_logo_wide.gif).
-</p>
-<p>Note: (diagramnotes.html) is replaced with (graph_legend.html) created by doxygen.
-</p>
+<anchor name="unixsetup"/>
+<s2 title="Setup UNIX for Building the Documents">
+<ol>
+<li>Requires the <code><em>Xalan</em></code> executable in the <code>${PATH}</code> environment.</li>
+<li>Requires the <code><em>libxerces-c.so</em></code> and
+ <code><em>libxalan-c.so</em></code> libraries in a path
+ that is accessible to the <code><em>Xalan</em></code> executable.</li>
+<li>Requires a current installation of the
+ <jump href="http://www.doxygen.org">Doxygen</jump> package.</li>
+<li>The interactive graphics for apiDocs require the
+ <jump href="http://www.graphviz.org">GraphViz</jump> (dot) package.</li>
+</ol>
+<anchor name="unixdocbld"/>
+<s3 title="Build the Documentation on UNIX">
+<ol>
+<li>Connect to the <code>${XALANC}/xdocs/</code> directory.</li>
+<li>Run the <code><em>make-apiDocs.sh</em></code> (full graphics) or
+ <code><em>make-apiDocs-nograf.sh</em></code> (no graphics).</li>
+<li>The script automatically chains to <code><em>sources/make-book.sh</em></code>
+ for building the remainder of the documentation.</li>
+<li>You can now relocate and package the documentation at
+ <code>${XALANC}/build/docs/xalan-c/</code>
+ to your final destination of choice.</li>
+</ol>
</s3>
-
-<anchor name="b_api_2"/>
-<s3 title="Destination Path for API Web Pages">
-
-<p>The Xalan-C/C++ API pages are constructed here.</p>
-<source>
- xalan/c/trunk/build/docs/apiDocs/html
-</source>
-</s3>
-
-<anchor name="b_api_3"/>
-<s3 title="Build the API Web Pages">
-
-<p>You must have usable "doxygen" and "dot" programs in your path. The "dot" program is part of the GraphViz distribution.
-</p>
-<p>Connect to your development sources or SVN snapshot.<br/>
-<source>
-xalan/c/trunk/xdocs/
-</source>
-Run the doxygen (or doxywizard) program.<br/>
-<source>
-doxygen DoxyfileXalan 2>errors.log | tee doxygen.log
-</source>
-Examine the (errors.log) file for any fatal errors. Lots of warnings are ok.
-You can examine the constructed web pages with your favorite browser.<br/>
-<source>
-% cd xalan/c/trunk/build/docs/apiDocs/html
-% iceweasel index.html &
+</s2>
+<anchor name="winsetup"/>
+<s2 title="Setup WINDOWS for Building the Documents">
+<ol>
+<li>Create a <code>%XALANC%\bin\</code> directory. Then copy the
+ <code><em>xalan.exe</em></code> and the DLL
+ libraries for xerces-c and xalan-c into that directory. This is where
+ the <code><em>make-xalan.bat</em></code> file expects to find the
+ <code><em>xalan.exe</em></code> executable.</li>
+
+<li>Connect to the <code>%XALANC%\xdocs\sources\</code> directory.</li>
+
+<li>Run the <code><em>make-book.bat</em></code> script to create
+ the <code>%XALANC%\build\docs\xalan-c\</code> documentation.</li>
+
+<li>You can now relocate and package the documentation at
+ <code>%XALANC%\build\docs\xalan-c\</code> to your final destination of choice.</li>
+</ol>
+<note>WINDOWS has no Doxygen program for building the apiDocs.
+Building apiDocs requires a Linux or UNIX platform. You might
+be able to use WINDOWS JavaDocs to get an interactive apiDocs reference.
+The JavaDocs program is part of the Java Developer's platform.</note>
+<p>Our documentation does not rely on any Java installation.</p>
+</s2>
+<anchor name="aboutstylebook"/>
+<s2 title="About the StyleBook XML Markup">
+<p>The obsolete Apache Java Stylebook program is no longer being used.
+The StyleBook XML markup has been slightly modified to accommodate
+standard XSLT stylesheet transformations.</p>
+<p>A standard <code><em>stylebook.xslt</em></code> XML transform stylesheet now
+allows any standard compliant XSLT processor to prepare the
+basic webpage documents. The resulting documents are in strict
+XHTML. The source pages have been adjusted so that
+compliant XML output mode is used and that transitional web
+browsers are accommodated.</p>
+<p>We also include a DTD library so that the markup source pages
+can be processed with a validating XML parser. The parser used
+with the <code><em>stylebook.xslt</em></code> stylesheet
+must accommodate top-level string parameters and the ability to
+process DTD definitions.</p>
+<p>Our stylebook processing scripts currently expect to use the
+Apache Xalan-C/C++ command-line executable program.</p>
+
+<anchor name="sb_dirlayout"/>
+<s3 title="Source Directory Layout">
+<source>
+ ${XALAN}/xdocs/style/dtd/* -- the validation DTD definitions
+ ${XALAN}/xdocs/sources/stylebook.xslt -- the XML StyleBook transform
+ ${XALAN}/xdocs/sources/xalan/* -- the StyleBook XML page content
+ ${XALAN}/xdocs/sources/xalan-graphic/* -- page specific graphics
+ ${XALAN}/xdocs/sources/xslt-resources/* -- logos and css stylesheets
+ ${XALAN}/xdocs/sources/xalan.xml -- the book navigation panel
+ ${XALAN}/xdocs/sources/entities.ent -- book XML general entity definitions
+ ${XALAN}/xdocs/sources/xalan/resources.xml -- general resource links
+ ${XALAN}/build/docs/xalan-c/* -- the StyleBook html transformed pages
+</source>
+<p>The resulting document from <code><em>stylebook.xslt</em></code> is strict XHTML with
+markup rules that can also be supported on transitional browsers.
+To guard against XML element collapse, we use the Unicode
+zero-width-non-joining character to provide non-empty content.
+Element collapse prevention is not handled by the "stylebook.xslt" transform.
+The Apache <code>Xalan</code> or <code>xalan.exe</code> programs do not
+should guard against unwanted element collapse.</p>
+</s3>
+<anchor name="sb_scripts"/>
+<s3 title="Document Building Scripts">
+<source>
+ ${XALAN}/xdocs/sources/make-xalan.sh {pagename} -- transform a single page
+ ${XALAN}/xdocs/sources/make-xalan.bat {pagename} -- transform a single page
+</source><source>
+ ${XALAN}/xdocs/sources/make-book.sh -- transform an entire book
+ ${XALAN}/xdocs/sources/make-book.bat -- transform an entire book
</source>
-</p>
</s3>
</s2>
+</s1>
+
-<anchor name="integrateapi"/>
-<s2 title="Integrate API With Xalan-C Project Web Pages">
-<p>Copy the contents of <br/>
-<source>
-xalan/c/trunk/build/docs/apiDocs/html/*
-</source>
-to the Xalan-C Project Web Pages found at <br/>
-<source>xalan/c/trunk/build/docs/html/apiDocs/
-</source>
-Copy the trademark logo <br/>
-<source>
-xalan/c/trunk/xdocs/html/apiDocs/asf_logo_wide.gif
-</source>
-to its final resting place <br/>
-<source>
-xalan/c/trunk/build/docs/html/apiDocs/
-</source>
-</p>
-</s2>
-</s1>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xalan.apache.org
For additional commands, e-mail: commits-help@xalan.apache.org