# build property defaults ================================================= # The directory in which to put the output files. # This directory is created if it does not exist. output-dir=generated-output # The XSLT used to 'profile' doc generation. profile-xsl=${p4-build-dir}/docbook-xsl-ns-1.78.1/profiling/profile.xsl # If you are using a customization layer that imports webhelp.xsl, use # this property to point to it. stylesheet-path=${p4-build-dir}/perforce/assets/publicsite/publicsite.xsl # By default, the ant script assumes your images are stored # in the same directory as the input-xml. If you store your # image directories in another directory, specify it here. # and uncomment this line. assets-basedir=assets/publicsite # If your document has image directories that need to be copied # to the output directory, you can list patterns here. # See the Ant documentation for fileset for documentation # on patterns. assets-dirs=images/** # specify the filename for generated PDFs pdf-output-filename=guide.pdf # global DocBook styling properties ======================================= # The extension for files to be indexed (html/htm/xhtml etc.) html.extension=html # Set this to false to exclude the search pane from HTML webhelp.include.search.tab=1 # indexer-language is used to tell the search indexer which language # the docbook is written. This will be used to identify the correct # stemmer, and punctuations that differs from language to language. # see the documentation for details. en=English, fr=French, de=German, # zh=Chinese, ja=Japanese etc. webhelp.indexer.language=en # Enables/Disables stemming # Stemming allows better querying for the search enable.stemming=true #Set the table of contents file. This file will not be indexed. #toc.file=dummy.html #Used for adding branding specific contents to the html files. #For example, the url docbook.org, Google Analytics id etc. branding=docbook brandname=DocBook # Set admon.graphics to 1 to user graphics for note, tip, etc. admon.graphics=0 suppress.footer.navigation=0 # Use this property to specify a list of file # names to exclude from indexing. For example, # you may choose not to index your book index. indexer-excluded-files=ix01.html # default chunking options chunk.first.sections=0 chunk.section.depth=0 chunk.separate.lots=1 chunk.tocs.and.lots=1 # autolabel defaults appendix.autolabel=0 part.autolabel=0 qandadiv.autolabel=0 reference.autolabel=0 generate.legalnotice.link=0 generate.section.toc.level=6 toc.section.depth=5 # disable ulink URL presentation ulink.show=0
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#6 | 12808 | eedwards |
Update the comment for webhelp.include.search.tab to better reflect what it does and revise its default value to use an integer rather than a boolean. |
||
#5 | 12806 | eedwards |
Retire the mechanism for selecting the stylesheet for 'profiling', since it only worked by accident and it is unnecessary to do this differently for the various output formats. The path to profile.xsl is now specified in global.properties. This should have no effect on production of HTML or PDF for any guide. |
||
#4 | 12802 | eedwards |
Set ulink.show=0 globally. This prevents links from displaying the associated URL when the link label does not match the URL. Individual guides that prefer the URL presentation can set ulink.show=1 in their own build.properties file. |
||
#3 | 12736 | eedwards |
Re-enable TOC generation for PDFs. Include some really minor XSL cleanup. |
||
#2 | 12731 | eedwards |
Apply new HTML/PDF generation infrastructure to CmdRef, P4API, P4Dist, and P4Guide. |
||
#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. |