mirror of
https://github.com/ganelson/inform.git
synced 2024-07-16 22:14:23 +03:00
494 lines
29 KiB
HTML
494 lines
29 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>M/iti</title>
|
|
<meta name="viewport" content="width=device-width initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta http-equiv="Content-Language" content="en-gb">
|
|
<link href="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
</head>
|
|
<body>
|
|
<nav role="navigation">
|
|
<h1><a href="../webs.html">Sources</a></h1>
|
|
<ul>
|
|
<li><a href="../compiler.html">compiler</a></li>
|
|
<li><a href="../other.html"><b>other tools</b></a></li>
|
|
<li><a href="../extensions.html">extensions and kits</a></li>
|
|
<li><a href="../units.html">unit test tools</a></li>
|
|
</ul>
|
|
<h2>Other Tools</h2>
|
|
<ul>
|
|
<li><a href="../inblorb/index.html">inblorb</a></li>
|
|
<li><a href="../indoc/index.html">indoc</a></li>
|
|
<li><a href="../inpolicy/index.html">inpolicy</a></li>
|
|
<li><a href="../inrtps/index.html">inrtps</a></li>
|
|
</ul>
|
|
<h2>Foundation</h2>
|
|
<ul>
|
|
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
<main role="main">
|
|
|
|
<!--Weave of 'M/vai' generated by 7-->
|
|
<ul class="crumbs"><li><a href="../webs.html">Source</a></li><li><a href="../other.html">Other Tools</a></li><li><a href="index.html">indoc 4</a></li><li><a href="index.html#M">Manual</a></li><li><b>Volumes and Instructions</b></li></ul><p class="purpose">Dual- versus single-volume mode, and how to write instructions files.</p>
|
|
|
|
<ul class="toc"><li><a href="#SP1">§1. Model</a></li><li><a href="#SP2">§2. Project instructions</a></li><li><a href="#SP3">§3. Durham Core metadata</a></li><li><a href="#SP4">§4. Targets</a></li><li><a href="#SP5">§5. Symbols</a></li><li><a href="#SP6">§6. Other instructions</a></li><li><a href="#SP7">§7. Miscellaneous settings</a></li></ul><hr class="tocbar">
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. Model. </b>Conceptually, an Indoc project has either one or two volumes. The source for
|
|
each volume is a single UTF-8 encoded plain text file. In the core Inform
|
|
repository, there are two volumes, with the files being
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">Documentation/Writing with Inform.txt</span>
|
|
<span class="plain">Documentation/The Recipe Book.txt</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">These are independent books, with individual titles. It would seem simpler
|
|
just to make them two different Indoc projects, but in dual-volume mode,
|
|
Indoc can generate joint contents pages, and provide crosswise HTML links
|
|
between the two volumes.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">The project can also include a number of "Examples", each being a single
|
|
text file such as:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">Documentation/Examples/Prague.txt</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">which is the source for an Inform example called "The Prague Job".
|
|
(These same text files are also used by Intest to test that all of the code
|
|
samples included in the Inform documentation actually work as claimed.)
|
|
There can be any number of examples, including none; Inform currently has 468.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">Each volume is divided into a series of chapters, and each chapter into a
|
|
series of sections. Examples are always placed at the ends of sections;
|
|
note that in dual-volume mode, examples are (mostly) present in both volumes,
|
|
giving them two different locations. Thus, "The Prague Job" appears in section
|
|
"More general linkages" of chapter "Scenes" of volume "Writing with Inform",
|
|
and also in section "Scripted Scenes" of chapter "Time and Plot" of volume
|
|
"The Recipe Book".
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP2"></a><b>§2. Project instructions. </b>The main instructions file for an Indoc project is, as noted earlier, at:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">Documentation/indoc-instructions.txt</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">An instruction file is a UTF-8 encoded plain text file. Single instructions
|
|
occupy single lines (i.e., line breaks are significant). A white-space line,
|
|
or a line whose first non-white-space character is a <code class="display"><span class="extract">#</span></code>, are ignored.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">The file should begin by specifying one or two volumes, and then, if they
|
|
will contain Examples in the above sense, by giving the special <code class="display"><span class="extract">examples</span></code>
|
|
instruction. Inform opens thus:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">volume: Writing with Inform</span>
|
|
<span class="plain">volume: The Inform Recipe Book (RB) = The Recipe Book.txt</span>
|
|
<span class="plain">examples</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">But a simpler, single-volume project might have just:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">volume: Pandemonium 2.0 for Fun and Profit</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">Each volume has a title, and Indoc automatically generates an abbreviation
|
|
for it: by default, it takes the capital letters from the title, so that it
|
|
abbreviates "Writing with Inform" to WI. That same method would have made
|
|
turned "The Inform Recipe Book" into TIRB, but because we didn't want that,
|
|
we supplied our own abbreviation RB instead.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">The third, also optional, part of a <code class="display"><span class="extract">volume</span></code> instruction specifies the
|
|
leafname of the documentation source file for it. By default, this will be
|
|
the title plus <code class="display"><span class="extract">.txt</span></code>: for example, <code class="display"><span class="extract">Writing with Inform.txt</span></code>. But we can
|
|
use <code class="display"><span class="extract">= X</span></code> to specify that it should be <code class="display"><span class="extract">X</span></code> instead.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">Two other project instructions exist:
|
|
</p>
|
|
|
|
<p class="inwebparagraph">If the project will contain images, then they will be looked for in a list
|
|
of places. Top of the list is a directory internal to Indoc which includes
|
|
some navigation icons such as <code class="display"><span class="extract">arrow-up.png</span></code>. The instruction <code class="display"><span class="extract">images: X</span></code>
|
|
adds the directory <code class="display"><span class="extract">X</span></code> to this source list.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">Lastly, the cover image for the project can be specified with an instruction
|
|
such as:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">cover: combined_cover.png</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">This specifies a leafname which must exist in one of the image sources
|
|
mentioned above.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3"></a><b>§3. Durham Core metadata. </b>If the project needs to generate Epub books, then these will need to have
|
|
some basic DC ("Durham Core") metadata supplied. For example:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">dc:title: Inform - A Design System for Interactive Fiction</span>
|
|
<span class="plain">dc:creator: Graham Nelson and Emily Short</span>
|
|
<span class="plain">dc:subject: Interactive Fiction</span>
|
|
<span class="plain">dc:identifier: wwi-rb-combined</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">The instruction <code class="display"><span class="extract">dc:KEY: VALUE</span></code> supplies a DC key-value pair.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP4"></a><b>§4. Targets. </b>The instructions file typically begins as above, but then goes into a
|
|
block of general settings or instructions (for which see below); and
|
|
eventually gets around to describing one or more targets. A target
|
|
looks like so:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">IDENTIFIER {</span>
|
|
<span class="plain"> ...</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">where <code class="display"><span class="extract">IDENTIFIER</span></code> is its name. Targets, as noted in the introduction,
|
|
are different forms of the documentation we might need to produce: Inform,
|
|
for example, has targets called <code class="display"><span class="extract">plain</span></code>, <code class="display"><span class="extract">website</span></code>, <code class="display"><span class="extract">linux_app</span></code> and so on.
|
|
What's important here is not that these are written to different locations
|
|
on disc (though they are) but that they have finicky little differences
|
|
in settings. The <code class="display"><span class="extract">...</span></code> stretch of lines can specify these. For example:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">ebook {</span>
|
|
<span class="plain"> granularity = 2</span>
|
|
<span class="plain"> examples_mode = open</span>
|
|
<span class="plain"> follow: epub-css-tweaks.txt</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">makes two specific settings and one instruction, all applying only for the
|
|
target <code class="display"><span class="extract">ebook</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP5"></a><b>§5. Symbols. </b>The instruction <code class="display"><span class="extract">declare: SYMBOL</span></code> creates the symbol <code class="display"><span class="extract">SYMBOL</span></code>. These exist
|
|
so that we can mark certain paragraphs of documentation as being present in
|
|
only some of the targets.
|
|
</p>
|
|
|
|
<p class="inwebparagraph">For example, we might want Linux installation instructions to appear only
|
|
in the Linux version of a manual. To do that, we'll need the symbol:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">linux_app {</span>
|
|
<span class="plain"> ...</span>
|
|
<span class="plain"> declare: Linux</span>
|
|
<span class="plain"> ...</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">In the documentation, we could then mark up a paragraph like so:
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">{Linux:}To install, first...</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">The symbol <code class="display"><span class="extract">indoc</span></code> is always declared, but by default no other symbols are.
|
|
Lastly, <code class="display"><span class="extract">undeclare: SYMBOL</span></code> removes a symbol.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP6"></a><b>§6. Other instructions. </b><code class="display"><span class="extract">follow: I</span></code> tells Indoc to follow the instructions file <code class="display"><span class="extract">I</span></code>. This works
|
|
rather like <code class="display"><span class="extract">#include</span></code> in C, or similar languages. If the <code class="display"><span class="extract">follow:</span></code> is
|
|
included inside a target block, then it affects only that target. On
|
|
other targets, the file <code class="display"><span class="extract">I</span></code> won't even be opened, and need never exist.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">css:</span></code> specifies additional CSS (Cascading Style Sheet) styling. This
|
|
will be needed only if, for example, unusual indexing features are used,
|
|
in which different categories of index entry need different visual styling.
|
|
For example,
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">css: span.indextitle ++ {</span>
|
|
<span class="plain"> font-style: italic;</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">Here the material between the braces is pure CSS, not Indoc syntax. The
|
|
notation <code class="display"><span class="extract">++</span></code> here tells Indoc that an entirely new CSS style is being
|
|
created; <code class="display"><span class="extract">+</span></code> would supply new lines to an existing style.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">index: NOTATION = CATEGORY OPTION</span></code> defines a new indexing markup notation;
|
|
for example,
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">index: ^{@headword} = name (invert)</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">says that markup notations like <code class="display"><span class="extract">^{@Andrew Plotkin}</span></code> put a name into the index,
|
|
which should be an index entry of category <code class="display"><span class="extract">name</span></code>, and should be inverted,
|
|
in that it will be alphabetised under "Plotkin, Andrew". The text <code class="display"><span class="extract">headword</span></code>
|
|
in the prototype is where the entry text should appear in the notation.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP7"></a><b>§7. Miscellaneous settings. </b>There are a great many of these, but most are set to sensible defaults,
|
|
and it is not compulsory to set any of them. Lines such as
|
|
</p>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="plain">SETTING = VALUE</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">change the default settings if need be. Here is an A-Z list; they're really
|
|
too miscellaneous to be grouped usefully by subject matter.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">alphabetization</span></code> sets the index sorting algorithm. The default is
|
|
<code class="display"><span class="extract">letter-by-letter</span></code>; the alternative is <code class="display"><span class="extract">word-by-word</span></code>. The difference is
|
|
that letter-by-letter would ignore word divisions and sort in the order
|
|
"peach", "peachpit", "peach tree"; whereas word-by-word would go for
|
|
"peach", "peach tree", "peachpit".
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">assume_Public_Library</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">no</span></code>. This
|
|
specifies whether special HTML links to the Public Library will be valid;
|
|
outside of Inform UI apps, the answer is definitely no.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">change_logs_directory</span></code> is the path to a directory holding Inform release
|
|
change log files. By default, this will be <code class="display"><span class="extract">Documentation/Change Logs</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">contents_leafname</span></code> is the (unextended) leafname to give the HTML contents
|
|
page. The default is <code class="display"><span class="extract">index</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">contents_expandable</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">no</span></code>. This sets
|
|
whether Javascript-powered "expand" buttons are to be used in the contents
|
|
page, and has effect only on the Midnight navigation design.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">css_source_file</span></code> is the filename of the CSS style sheet to use. The default
|
|
is the <code class="display"><span class="extract">base.css</span></code> file included in the Indoc distribution.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">definitions_filename</span></code> is the filename to use if you would like Indoc to
|
|
output a special file of Inform phrase definitions, for use by Inform itself
|
|
when it generates indexes. The default for this is <code class="display"><span class="extract">definitions.html</span></code>. This
|
|
has nothing to do with the <code class="display"><span class="extract">definitions_index_filename</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">definitions_index_filename</span></code> is the leafname to use for the General Index
|
|
in the documentation. The default is <code class="display"><span class="extract">general_index.html</span></code>. This
|
|
has nothing to do with the <code class="display"><span class="extract">definitions_filename</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">destination</span></code> is the directory into which output is generated. The default
|
|
is <code class="display"><span class="extract">Documentation/Output</span></code>. Note that specifying <code class="display"><span class="extract">-to X</span></code> at the command line
|
|
overrides this setting: if <code class="display"><span class="extract">-to</span></code> is used, <code class="display"><span class="extract">destination</span></code> is ignored.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">examples_directory</span></code> is the directory holding the Example files. The default
|
|
is <code class="display"><span class="extract">Documentation/Examples</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">examples_alphabetical_leafname</span></code> is the leafname to use for the alphabetical
|
|
index of examples in the documentation. The default is <code class="display"><span class="extract">examples_alphabetical.html</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">examples_granularity</span></code> is 1, 2, or 3. It can never be less than <code class="display"><span class="extract">granularity</span></code>,
|
|
and by default is equal to it. It specifies where examples should appear:
|
|
at the end of the relevant volume (1), chapter (2), or section (3).
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">examples_mode</span></code> is <code class="display"><span class="extract">open</span></code> or <code class="display"><span class="extract">openable</span></code>, and is by default <code class="display"><span class="extract">open</span></code>. Open means
|
|
that an example has its full contents visible by default; openable means that
|
|
the contents are hidden behind a Javascript-powered button which causes them
|
|
to be revealed.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">examples_numerical_leafname</span></code> is the leafname to use for the numerical
|
|
index of examples in the documentation. The default is <code class="display"><span class="extract">examples_numerical.html</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">examples_thematic_leafname</span></code> is the leafname to use for the thematic
|
|
index of examples in the documentation. The default is <code class="display"><span class="extract">examples_thematic.html</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">format</span></code> is the most important of all the settings, and is <code class="display"><span class="extract">HTML</span></code> or <code class="display"><span class="extract">text</span></code>,
|
|
but by default <code class="display"><span class="extract">HTML</span></code> unless the target name is <code class="display"><span class="extract">plain</span></code>, in which case <code class="display"><span class="extract">text</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">granularity</span></code> is 1, 2, or 3. The default is 3 unless the target is called
|
|
<code class="display"><span class="extract">webpage</span></code> or <code class="display"><span class="extract">plain</span></code>, in which case it is 1. This specifies how much the
|
|
documentation is broken down into pieces. 1 means "each volume in a single
|
|
HTML file"; 2 means "each chapter", 3 means "each section". Low granularity
|
|
means fewer but larger files, high granularity more but smaller files.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">html_for_Inform_application</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">no</span></code>. This
|
|
specifies whether the HTML is for use inside the Inform UI application, and
|
|
can therefore use links with the special HTTP transports only available there.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">images_copy</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">yes</span></code>. In this mode,
|
|
any needed image files are copied into place into the <code class="display"><span class="extract">images_path</span></code>. (The
|
|
alternative assumes they are already there, and should be used if <code class="display"><span class="extract">images_path</span></code>
|
|
is some URL external to the HTML being generated.)
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">images_path</span></code> is where the generated HTML expects to find its image files.
|
|
The default is <code class="display"><span class="extract">~~/Images/</span></code>, where <code class="display"><span class="extract">~~</span></code> means the destination directory:
|
|
that is, the default is a subdirectory called <code class="display"><span class="extract">Images</span></code> of the destination.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">inform_definitions_mode</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">no</span></code>. This
|
|
is cosmetic, and provides extra styling on lines of documentation giving the
|
|
syntax for Inform phrases.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">javascript</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">yes</span></code>. This indicates
|
|
whetber Indoc is allowed to compile Javascript, or has to stick to inactive
|
|
HTML.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">javascript_paste_method</span></code> can be <code class="display"><span class="extract">none</span></code>, <code class="display"><span class="extract">Andrew</span></code> or <code class="display"><span class="extract">David</span></code>. The default
|
|
is <code class="display"><span class="extract">none</span></code>. The difference relates to how "paste Inform source" links are
|
|
implemented inside the Inform application: <code class="display"><span class="extract">Andrew</span></code> mode is suitable for
|
|
most platforms, but <code class="display"><span class="extract">David</span></code> is needed for Windows.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">link_to_extensions_index</span></code> is meaningful only if <code class="display"><span class="extract">html_for_Inform_application</span></code>
|
|
is set, and specifies the URL of the Extensions index inside the app.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">manifest_leafname</span></code> is meaningful only if <code class="display"><span class="extract">html_for_Inform_application</span></code>
|
|
is set, and is by default <code class="display"><span class="extract">manifest.txt</span></code>. This provides a cross-reference
|
|
list of files generated by Indoc.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">navigation</span></code> is the design used for navigation links in the HTML produced.
|
|
There are currently six designs, called <code class="display"><span class="extract">architect</span></code>, <code class="display"><span class="extract">lacuna</span></code>, <code class="display"><span class="extract">midnight</span></code>,
|
|
<code class="display"><span class="extract">roadsign</span></code>, <code class="display"><span class="extract">twilight</span></code>, and <code class="display"><span class="extract">unsigned</span></code>; the default is <code class="display"><span class="extract">roadsign</span></code>, though
|
|
inside the Inform applications, the design chosen is usually <code class="display"><span class="extract">architect</span></code>.
|
|
If the format is <code class="display"><span class="extract">text</span></code> not <code class="display"><span class="extract">HTML</span></code>, then the design is always <code class="display"><span class="extract">lacuna</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">retina_images</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">no</span></code>. This indicates
|
|
whether MacOS/iOS "retina" versions of the paste and create icons are
|
|
available: <code class="display"><span class="extract">paste@2x.png</span></code> and <code class="display"><span class="extract">create@2x.png</span></code> respectively.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">support_creation</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">no</span></code>. This indicates
|
|
whether the Examples have a "create" button which creates a new Inform
|
|
project demonstrating them in action; this can only be done in the UI apps,
|
|
so it should always be <code class="display"><span class="extract">no</span></code> unless <code class="display"><span class="extract">html_for_Inform_application</span></code> is <code class="display"><span class="extract">yes</span></code>.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">suppress_fonts</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">no</span></code>. If <code class="display"><span class="extract">yes</span></code>, this
|
|
strips out lists of fonts to use in CSS, leaving only whether they are
|
|
<code class="display"><span class="extract">monospace</span></code> or not.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">toc_granularity</span></code> is 1, 2, or 3. It can never be less than <code class="display"><span class="extract">granularity</span></code>,
|
|
and by default is 3. It shows the level of detail in the table of contents: 1
|
|
means volumes, 2 means volumes and chapters, 3 goes down to sections.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">top_and_tail</span></code> specifies a prototype HTML file to follow for the more
|
|
important HTML pages generated by Indoc. The default is not to. If
|
|
this exists, it can provide a surround for the HTML we generate — for
|
|
example, it can contain website-specific navigation, or a banner across
|
|
the top. The prototype should somewhere include the text <code class="display"><span class="extract">[TEXT]</span></code>, and
|
|
this will be replaced with whatever Indoc generates.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">top_and_tail_sections</span></code> is the same as <code class="display"><span class="extract">top_and_tail</span></code>, but for individual
|
|
section files.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">treat_code_as_verbatim</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">yes</span></code>. This
|
|
affects the styling of marked-up code material in documentation. Without
|
|
it, code markup is largely unavailable.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">wrapper</span></code> can be <code class="display"><span class="extract">EPUB</span></code>, <code class="display"><span class="extract">zip</span></code> or <code class="display"><span class="extract">none</span></code>. The default is <code class="display"><span class="extract">none</span></code>. The wrapper
|
|
is put around the whole mass of generated HTML; <code class="display"><span class="extract">EPUB</span></code> makes the result an
|
|
Epub-format ebook.
|
|
</p>
|
|
|
|
<p class="inwebparagraph"><code class="display"><span class="extract">XHTML</span></code> can be <code class="display"><span class="extract">yes</span></code> or <code class="display"><span class="extract">no</span></code>. The default is <code class="display"><span class="extract">no</span></code>. This forces the HTML we
|
|
produce to conform to XHTML 1.1 Strict. If the <code class="display"><span class="extract">wrapper</span></code> is <code class="display"><span class="extract">EPUB</span></code>, then
|
|
this is automatically set to <code class="display"><span class="extract">yes</span></code>.
|
|
</p>
|
|
|
|
<hr class="tocbar">
|
|
<ul class="toc"><li><a href="M-iti.html">Back to 'Introduction to Indoc'</a></li><li><a href="M-dm.html">Continue with 'Documentation Markup'</a></li></ul><hr class="tocbar">
|
|
<!--End of weave-->
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|