Menu
▾
▴
SF.net SVN: docbook:[9691] trunk/xsl/webhelp
|
From: <dc...@us...> - 2012-12-16 02:01:07
|
Revision: 9691
http://docbook.svn.sourceforge.net/docbook/?rev=9691&view=rev
Author: dcramer
Date: 2012-12-16 02:01:00 +0000 (Sun, 16 Dec 2012)
Log Message:
-----------
Webhelp: Improving sample Makefile to allow for profiling params and other params, removing content dir from template and making related adjustments in Makefile and build.xml
Modified Paths:
--------------
trunk/xsl/webhelp/Makefile
trunk/xsl/webhelp/Makefile.sample
trunk/xsl/webhelp/build.xml
Added Paths:
-----------
trunk/xsl/webhelp/template/search/
Removed Paths:
-------------
trunk/xsl/webhelp/template/content/
Modified: trunk/xsl/webhelp/Makefile
===================================================================
--- trunk/xsl/webhelp/Makefile 2012-12-15 03:37:18 UTC (rev 9690)
+++ trunk/xsl/webhelp/Makefile 2012-12-16 02:01:00 UTC (rev 9691)
@@ -47,7 +47,7 @@
-classpath $(classpath) \
com.nexwave.nquindexer.IndexerMain
- cp -r template/content/search/* ${OUTPUT_DIR}/search
+ cp -r template/search/* ${OUTPUT_DIR}/search
clean:
$(RM) -r docs/*
Modified: trunk/xsl/webhelp/Makefile.sample
===================================================================
--- trunk/xsl/webhelp/Makefile.sample 2012-12-15 03:37:18 UTC (rev 9690)
+++ trunk/xsl/webhelp/Makefile.sample 2012-12-16 02:01:00 UTC (rev 9691)
@@ -1,13 +1,55 @@
# Configuration
-DOCBOOK_DIST := ../$(pwd)
+# The name of the source DocBook xml file
+INPUT_XML = docsrc/readme.xml
-DOCBOOK_EXTENSIONS_DIR = $(DOCBOOK_DIST)/extensions
+# 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
-INPUT_XML = docsrc/readme.xml
-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
@@ -28,11 +70,26 @@
chunk:
xsltproc --output xincluded-profiled.xml \
- --stringparam profile.os "linux" \
+ --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 --xinclude xsl/webhelp.xsl xincluded-profiled.xml
+ xsltproc ${OTHER_XSLTPROC_ARGS} --xinclude xsl/webhelp.xsl xincluded-profiled.xml
rm xincluded-profiled.xml
index:
@@ -47,8 +104,8 @@
-classpath $(classpath) \
com.nexwave.nquindexer.IndexerMain
- cp -r template/content/search/* ${OUTPUT_DIR}/search
+ cp -r template/search/* ${OUTPUT_DIR}/search
clean:
- $(RM) -r docs/*
+ $(RM) -r ${OUTPUT_DIR}
Modified: trunk/xsl/webhelp/build.xml
===================================================================
--- trunk/xsl/webhelp/build.xml 2012-12-15 03:37:18 UTC (rev 9690)
+++ trunk/xsl/webhelp/build.xml 2012-12-16 02:01:00 UTC (rev 9691)
@@ -75,7 +75,7 @@
<copy todir="${output-dir}">
<fileset dir="${ant.file.dir}/template">
<include name="**/*"/>
- <exclude name="**/content/**"/>
+ <exclude name="**/search/**"/>
</fileset>
</copy>
@@ -91,7 +91,7 @@
<target name="index" if="do-search-indexing">
<copy todir="${output-dir}/search">
- <fileset dir="${ant.file.dir}/template/content/search">
+ <fileset dir="${ant.file.dir}/template/search">
<include name="**/*"/>
<exclude name="**/*.props"/>
<exclude name="**/stemmers/*"/>
@@ -100,7 +100,7 @@
<!-- We separate this out so we only copy the stopwords list and stemmer for the indexer language -->
<copy todir="${output-dir}/search">
- <fileset dir="${ant.file.dir}/template/content/search">
+ <fileset dir="${ant.file.dir}/template/search">
<include name="**/default.props"/>
<include name="**/punctuation.props"/>
<include name="**/${webhelp.indexer.language}*.props"/>
@@ -108,11 +108,6 @@
</fileset>
</copy>
- <!--taskdef name="indexertask"
- classname="com.nexwave.nquindexer.IndexerMain">
- <classpath refid="classpath"/>
- </taskdef-->
-
<echo>Indexing html files in ${output-dir}</echo>
<java classname="com.nexwave.nquindexer.IndexerMain" fork="true">
@@ -121,7 +116,7 @@
<sysproperty key="htmlExtension" value="${html.extension}"/>
<sysproperty key="doStem" value="${enable.stemming}"/>
<sysproperty key="tocFile" value="${toc.file}"/>
- <sysproperty key="indexerExcludedFiles" value="${indexer-excluded-files}"/>
+ <sysproperty key="indexerExcludedFiles" value="${indexer-excluded-files}"/>
<!--TagSoup SAX Parser for parsing even the bad html contents. see
http://sourceforge.net/tracker/?func=detail&aid=3401185&group_id=21935&atid=373750-->
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|