[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[publican-list] chunking options for html



Hi,

This was sent internally (from Jeff Fearn), and I have not got around to adding it to the guide. The following only works with "make html" (not html-single):

---

The following options can be set in the Makefile. The CHUNK options must be set before the include section. For example:

XML_LANG        = en-US
DOCNAME         = Portal_EAP
PRODUCT = JBoss_Portal
BRAND           = JBoss

#OTHER_LANGS    = as-IN bn-IN de-DE es-ES
TRANSLATIONS    = $(XML_LANG) $(OTHER_LANGS)

CHUNK_SECTION_DEPTH = 1

COMMON_CONFIG  = /usr/share/documentation-devel
include $(COMMON_CONFIG)/make/Makefile.common


A space is required between the variable name and the value: "CHUNK_SECTION_DEPTH=1" will not work!

1: Default (chunking)

When no options are set all sections are on their own page.

2: CHUNK_FIRST = 0


First level 1 section is on same page as the chapter. All other sections are on their own page, for example:

<chapter>

<para>
test
</para>

<section>
<para>this is a section</para>
</section>

<section>
<para>this is another section</para>
</section>

"test" and "this is a section" would appear on a single page. "this is another section" will be on a separate page.

3: CHUNK_FIRST = 0 and CHUNK_SECTION_DEPTH = 0


No sections are chunked, every chapter is on one page. For example, the following content would appear on a single page:

<chapter>

<para>
test
</para>

<section>
<para>this is a section</para>
</section>

<section>
<para>this is another section</para>
</section>

4: CHUNK_SECTION_DEPTH = 1

Every level 1 section is on its own page, and contains all its sub sections.

5: CHUNK_SECTION_DEPTH >= 2


Sections below the nominated depth are on the same page as sections of the nominated depth.

6:
CHUNK_FIRST = 0
CHUNK_SECTION_DEPTH = 1


First level 1 section is on same page as the chapter. All other sections are on their own page and contain all sub sections (eg nested sections).

---

Thanks,

Murray.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]