# Configuration # The name of the source DocBook xml file INPUT_XML = docsrc/readme.xml # The makefile assumes that you have a # directory named images that contains # your images. It copies this to the # output directory USER_IMAGES_PARENT_DIR=docsrc # Name of the desired output directory # This will be created if it doesn't exist OUTPUT_DIR = docs # A list of files to exclude from indexing INDEXER_EXCLUDED_FILES = ix01.html # Profiling params. For more information on # profiling (conditional text) and DocBook documents, see # http://www.sagehill.net/docbookxsl/Profiling.html PROFILE.ARCH = "" PROFILE.AUDIENCE = "" PROFILE.CONDITION = "" PROFILE.CONFORMANCE = "" PROFILE.LANG = "" PROFILE.OS = "" PROFILE.REVISION = "" PROFILE.REVISIONFLAG = "" PROFILE.ROLE = "" PROFILE.SECURITY = "" PROFILE.STATUS = "" PROFILE.USERLEVEL = "" PROFILE.VENDOR = "" PROFILE.WORDSIZE = "" PROFILE.ATTRIBUTE = "" PROFILE.VALUE = "" # Use this variable to pass in other stringparams # to the xsltproc pass that generates DocBook output. # For example: # OTHER_XSLTPROC_ARGS = --stringparam example.param "" OTHER_XSLTPROC_ARGS = # Path to the DocBook Distribution that # contains the xslts etc. DOCBOOK_DIST := ../$(pwd) # ================================================= # You probably don't need to change anything below # unless you choose to add a validation step. # ================================================ DOCBOOK_EXTENSIONS_DIR = $(DOCBOOK_DIST)/extensions INDEXER_JAR := $(DOCBOOK_EXTENSIONS_DIR)/webhelpindexer.jar TAGSOUP_JAR := $(DOCBOOK_EXTENSIONS_DIR)/tagsoup-1.2.1.jar LUCENE_ANALYZER_JAR := $(DOCBOOK_EXTENSIONS_DIR)/lucene-analyzers-3.0.0.jar LUCENE_CORE_JAR := $(DOCBOOK_EXTENSIONS_DIR)/lucene-core-3.0.0.jar classpath := $(INDEXER_JAR):$(TAGSOUP_JAR):$(LUCENE_ANALYZER_JAR):$(LUCENE_CORE_JAR) all: webhelp webhelp: $(INPUT_XML) copyfiles chunk index copyfiles: -rm -rf $(OUTPUT_DIR) mkdir -p $(OUTPUT_DIR) cp -r template/common ${OUTPUT_DIR} test ! -d $(USER_IMAGES_PARENT_DIR)/images/ || cp -r $(USER_IMAGES_PARENT_DIR)/images ${OUTPUT_DIR}/images cp template/favicon.ico ${OUTPUT_DIR}/ chunk: xsltproc --xinclude --output xincluded-profiled.xml \ --stringparam profile.arch ${PROFILE.ARCH} \ --stringparam profile.audience ${PROFILE.AUDIENCE} \ --stringparam profile.condition ${PROFILE.CONDITION} \ --stringparam profile.conformance ${PROFILE.CONFORMANCE} \ --stringparam profile.lang ${PROFILE.LANG} \ --stringparam profile.os ${PROFILE.OS} \ --stringparam profile.revision ${PROFILE.REVISION} \ --stringparam profile.revisionflag ${PROFILE.REVISIONFLAG} \ --stringparam profile.role ${PROFILE.ROLE} \ --stringparam profile.security ${PROFILE.SECURITY} \ --stringparam profile.status ${PROFILE.STATUS} \ --stringparam profile.userlevel ${PROFILE.USERLEVEL} \ --stringparam profile.vendor ${PROFILE.VENDOR} \ --stringparam profile.wordsize ${PROFILE.WORDSIZE} \ --stringparam profile.attribute ${PROFILE.ATTRIBUTE} \ --stringparam profile.value ${PROFILE.VALUE} \ ../profiling/profile.xsl \ ${INPUT_XML} xsltproc ${OTHER_XSLTPROC_ARGS} xsl/webhelp.xsl xincluded-profiled.xml rm xincluded-profiled.xml index: java \ -DhtmlDir=$(OUTPUT_DIR) \ -DindexerLanguage=en \ -DhtmlExtension=html \ -DdoStem=true \ -DindexerExcludedFiles=$(INDEXER_EXCLUDED_FILES) \ -Dorg.xml.sax.driver=org.ccil.cowan.tagsoup.Parser \ -Djavax.xml.parsers.SAXParserFactory=org.ccil.cowan.tagsoup.jaxp.SAXFactoryImpl \ -classpath $(classpath) \ com.nexwave.nquindexer.IndexerMain cp -r template/search/* ${OUTPUT_DIR}/search clean: $(RM) -r ${OUTPUT_DIR}
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 26953 | Paul Allen | Move //guest/perforce_software/p4convert to //guest/perforce_software/p4convert/main | ||
//guest/perforce_software/p4convert/docs/docbook-xsl-ns-1.78.1/webhelp/Makefile.sample | |||||
#2 | 14806 | Paul Allen | Update docs and add +w. | ||
#1 | 13920 | Paul Allen | copy part 2 (no errors) | ||
//guest/paul_allen/p4convert-maven/docs/docbook-xsl-ns-1.78.1/webhelp/Makefile.sample | |||||
#1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
//guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/webhelp/Makefile.sample | |||||
#1 | 12728 | eedwards |
Upgrade ANT doc build infrastructure to assemble PDFs: - remove non-namespaced DocBook source and add namespaced DocBook source. - add Apache FOP 1.1 - copy fonts, images, XSL into _build, establishing new asset structure. The original structure remains until all guides using it can be upgraded, and several other issues can be resolved. - updated build.xml to allow for per-target build properties. - upgraded the P4SAG to use the new infrastructure. - tweaked admonition presentation in PDFs to remove admonition graphics, and resemble closely the presentation used in the new HTML layout, including the same colors. With these changes, building PDFs involves using a shell, navigating into the guide's directory (just P4SAG for now), and executing "ant pdf". Issues still to be resolved: - PDF generation encounters several warnings about missing fonts (bold versions of Symbol and ZapfDingbats), and a couple of locations where the page content exceeds the defined content area. - Due to issues within Apache FOP, PDF generation emits a substantial amount of output that is not easily suppressed without losing important warning information. - Apache FOP's interface to ANT does not expose a way to set the font base directory. The current configuration does work under Mac OSX, but further testing on Windows will need to be done to determine if the relative paths defined continue to work. The workaround is for Windows users to customize the fop-config.xml to provide absolute system paths to the required fonts. - HTML generation needs further browser testing, and exhibits broken navigation on iOS browsers within the TOC sidebar. - A number of PDF and HTML presentation tweaks still need to be made, for example: sidebars, gui* DocBook tags, whitespace, section separation, etc. |