-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Draft topic on custom HTML .properties file #118
- Loading branch information
1 parent
9f71b00
commit 733905d
Showing
2 changed files
with
47 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd"> | ||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. --> | ||
|
||
<task id="custom-html-properties-file"> | ||
<title>Customizing HTML with a <filepath>.properties</filepath> file</title> | ||
<titlealts> | ||
<navtitle>Using a properties file</navtitle> | ||
</titlealts> | ||
<shortdesc>You can also use a <filepath>.properties</filepath> file to reference a set of build parameters when | ||
building output with the <cmdname>dita</cmdname> command. The DITA-OT documentation uses a | ||
<filepath>.properties</filepath> file to include custom CSS, header branding, and table-of-contents navigation in | ||
the HTML5 output.</shortdesc> | ||
<taskbody> | ||
|
||
<steps> | ||
<step> | ||
<cmd>Create a <filepath>.properties</filepath> file to store the parameter settings for your | ||
customization.</cmd> | ||
<info> | ||
<note type="tip">You can use the <filepath>.properties</filepath> for the DITA-OT documentation as a starting | ||
point for your own customizations. This file is available in the installation folder under | ||
<filepath>docsrc/samples/properties/docs-build-html5.properties</filepath>.</note> | ||
</info> | ||
<stepxmp>For example: <fig> | ||
<title>The <filepath>docsrc/samples/properties/docs-build-html5.properties</filepath> file</title> | ||
<codeblock><coderef href="../samples/properties/docs-build-html5.properties"/></codeblock> | ||
</fig> | ||
</stepxmp> | ||
</step> | ||
<step> | ||
<cmd>Reference your <filepath>.properties</filepath> file with the <cmdname>dita</cmdname> command when building | ||
your output.</cmd> | ||
<stepxmp> | ||
<codeblock><cmdname>dita</cmdname> <parmname>--input</parmname>=<varname>my.ditamap</varname> <parmname>--format</parmname>=<option>html5</option> <parmname>--propertyfile</parmname>=<varname>my.properties</varname></codeblock> | ||
</stepxmp> | ||
<info/> | ||
</step> | ||
</steps> | ||
<result> | ||
<note>For an example of HTML output generated using this method, see the HTML5 version of the DITA-OT | ||
documentation included in the installation folder under <filepath>doc/index.html</filepath>.</note> | ||
</result> | ||
</taskbody> | ||
</task> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters