Note — Customizing output
publican.cfg
) allow you to control many aspects of the way in which a document is presented — refer to Section 4.1.1, “The publican.cfg file”.
--config
to specify which configuration file (and therefore which set of parameters) to use in a particular build, for example:
$
publican build --formats html,pdf --langs en-US,de-DE,hu-HU --config community.cfg
YEAR
and HOLDER
entities have been configured in the Doc_Name.ent
file, as described in Section 4.1.6, “Doc_Name.ent”.
Test_Book
and is located in the ~/books/
directory, run the following command:
$
cd ~/books/Test_Book
$
publican build --formats=test --langs=en-US
$
publican build --formats=formats --langs=languages
html,html-single,pdf
. Replace langs with a comma-separated list of the languages that you want to build; for example, en-US,sv-SE,uk-UA,ko-KR
.
Formats for the build
action
html
chunk_first
and chunk_section depth
parameters in the publican.cfg
file to control how Publican chunks sections in this format.
html-single
html-desktop
man
pdf
test
txt
epub
eclipse
id
, name
, and provider-name
parameters with Publican's ec_id
, ec_name
, and ec_provider
parameters.
$
publican build
commands:
$
publican build --help
$
publican build
options for building a book.
$
publican build --formats=test --langs=languages
--formats=test
before running any other $
publican build
command, and before checking a book back into a version-controlled repository from which other contributors might download it.
$
publican build --formats=html --langs=languages
Doc_Name/tmp/language/html/
directory. Each chapter and major section is placed in a separate HTML file. You can control the depth at which Publican places subsections into separate HTML files with the chunk-section-depth
parameter in the publican.cfg
— refer to Section 4.1.1, “The publican.cfg file”.
$
publican build --formats=html-single --langs=languages
Doc_Name/tmp/language/html-single/
directory.
$
publican build --formats=pdf --langs=languages
Doc_Name/tmp/language/pdf/
directory.
$
publican build --formats=html,html-single,pdf --langs=languages
<xref>
s) to sections of the document that do not yet exist. To skip validation, run $
publican build
with the --novalid
option. Cross-references to non-existent content appear in the built document as three question marks: ???
.
--novalid
option is highly suspect. Do not publish documentation that you have built with the --novalid
option.