Skip to content

Commit

Permalink
Merge branch 'feature/cli-options' into hotfix/3.1.1
Browse files Browse the repository at this point in the history
* feature/cli-options:
  Link to output formats for CLI examples
  Add command line examples to output format topics
  Clarify Markdown format as example
  Wrap options in square brackets per EBNF convention
  • Loading branch information
infotexture committed Jul 2, 2018
2 parents 6be1240 + 34016c3 commit a4f65d0
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 4 deletions.
6 changes: 4 additions & 2 deletions resources/conref-task.dita
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<li id="novice-variables-last" audience="novice">
<p id="common-format-info">
<varname>format</varname> is the output format (transformation type).
This argument corresponds to the common parameter
This argument corresponds to the common parameter
<parmname>transtype</parmname>.
Use the same values as for the <parmname>transtype</parmname> build
parameter, for example <option>html5</option> or <option>pdf</option>.
Expand All @@ -87,9 +87,11 @@
<li><option>troff</option></li>
<li><option>xhtml</option></li>
</ul>
<note type="tip">See <xref keyref="output-formats"/> for sample command line syntax and more information
on each transformation.</note>
</p>
</li>
<li id="options"><varname>options</varname> include the following optional build parameters:
<li id="options"><varname>[options]</varname> include the following optional build parameters:
<parml conref="../parameters/dita-command-arguments.dita#dita-command-properties/dita_build_options">
<plentry>
<pt/>
Expand Down
6 changes: 6 additions & 0 deletions topics/dita2eclipsehelp.dita
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,11 @@
<p>To run the Eclipse help transformation, set the <parmname>transtype</parmname> parameter to
<option>eclipsehelp</option>, or pass the <parmname>--format</parmname>=<option>eclipsehelp</option> option to
the <cmdname>dita</cmdname> command line.</p>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>eclipsehelp</option></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
</ul>
</conbody>
</concept>
6 changes: 6 additions & 0 deletions topics/dita2html5.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,11 @@
<p>To run the HTML5 transformation, set the <parmname>transtype</parmname> parameter to <option>html5</option>, or
pass the <parmname>--format</parmname>=<option>html5</option> option to the <cmdname>dita</cmdname> command
line.</p>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>html5</option></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
</ul>
</conbody>
</concept>
6 changes: 6 additions & 0 deletions topics/dita2htmlhelp.dita
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,11 @@
<p>To run the HTML Help transformation, set the <parmname>transtype</parmname> parameter to
<option>htmlhelp</option>, or pass the <parmname>--format</parmname>=<option>htmlhelp</option> option to the
<cmdname>dita</cmdname> command line.</p>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>htmlhelp</option></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
</ul>
</conbody>
</concept>
3 changes: 2 additions & 1 deletion topics/dita2markdown.dita
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
<option>markdown_gitbook</option> transtype.</p></li>
</ul>
<p>Run the <cmdname>dita</cmdname> command and set the value of the output <parmname>--format</parmname> option to
the desired format:</p><codeblock xml:space="preserve"><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>markdown</option></codeblock>
the desired format, for example:</p>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>markdown</option></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
Expand Down
6 changes: 6 additions & 0 deletions topics/dita2pdf.dita
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,11 @@
PDF2. The plug-in was bundled into the default toolkit distribution with release 1.4.3.</p>
<p>To run the PDF transformation, set the <parmname>transtype</parmname> parameter to <option>pdf</option>, or pass
the <parmname>--format</parmname>=<option>pdf</option> option to the <cmdname>dita</cmdname> command line.</p>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>pdf</option></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
</ul>
</conbody>
</concept>
6 changes: 6 additions & 0 deletions topics/dita2tocjs.dita
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,11 @@
<p>To run the TocJS transformation, set the <parmname>transtype</parmname> parameter to <option>tocjs</option>, or
pass the <parmname>--format</parmname>=<option>tocjs</option> option to the <cmdname>dita</cmdname> command
line.</p>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>tocjs</option></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
</ul>
</conbody>
</concept>
6 changes: 6 additions & 0 deletions topics/dita2troff.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,11 @@
<p>To run the troff transformation, set the <parmname>transtype</parmname> parameter to <option>troff</option>, or
pass the <parmname>--format</parmname>=<option>troff</option> option to the <cmdname>dita</cmdname> command
line.</p>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>troff</option></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
</ul>
</conbody>
</concept>
6 changes: 6 additions & 0 deletions topics/dita2xhtml.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,11 @@
<p>To run the XHTML transformation, set the <parmname>transtype</parmname> parameter to <option>xhtml</option>, or
pass the <parmname>--format</parmname>=<option>xhtml</option> option to the <cmdname>dita</cmdname> command
line.</p>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>xhtml</option></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
</ul>
</conbody>
</concept>
2 changes: 1 addition & 1 deletion topics/using-dita-command.dita
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
</step>
<step>
<cmd>At the command-line prompt, enter the following command:</cmd>
<info><codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<varname>format</varname> <varname audience="expert">options</varname></codeblock>
<info><codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<varname>format</varname> <varname audience="expert">[options]</varname></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"
Expand Down

0 comments on commit a4f65d0

Please sign in to comment.