Reduce NewStuff 4.64 to a short list after full doc update.

[users/jgh/exim.git] / doc / doc-docbook / Markup.txt

diff --git a/doc/doc-docbook/Markup.txt b/doc/doc-docbook/Markup.txt
index 9220eb4e84cf1b0d094a78b00ce2cfb46f8a5365..302b84badaa57ec8af129e3c2bfd405a2f21d0e0 100644 (file)
--- a/doc/doc-docbook/Markup.txt
+++ b/doc/doc-docbook/Markup.txt
@@ -1,4 +1,4 @@
-$Cambridge: exim/doc/doc-docbook/Markup.txt,v 1.1 2006/02/01 11:01:01 ph10 Exp $
+$Cambridge: exim/doc/doc-docbook/Markup.txt,v 1.4 2006/12/19 12:28:35 ph10 Exp $

 
 XFPT MARKUP USED IN THE EXIM DOCUMENTATION
 ------------------------------------------
 
 XFPT MARKUP USED IN THE EXIM DOCUMENTATION
 ------------------------------------------


@@ -217,8 +217,16 @@ To create an index entry, include a line like one of these:
   .oindex "primary text" "secondary text"
 
 The first is for the "concept index" and the second is for the "options index".
   .oindex "primary text" "secondary text"
 
 The first is for the "concept index" and the second is for the "options index".

-Not all forms of output distinguish between these - sometimes there is just one
-index.
+The secondary text is of course optional. Not all forms of output distinguish
+between these - sometimes there is just one index. For the concept index, it is
+also possible to set "start" and "end" markers so that the entry lists a range
+of pages. This is how to do that:
+
+  .scindex IID "primary text" "secondary text"
+  <intervening text, should be several pages>
+  .ecindex IID
+
+The IID must be some unique string to tie the entries together.

 
 The index for the Exim reference manual has a number of "see also" entries.
 These are coded in raw XML at the start of the source file.
 
 The index for the Exim reference manual has a number of "see also" entries.
 These are coded in raw XML at the start of the source file.


@@ -327,6 +335,12 @@ When called without an argument, .new terminates the current paragraph, and
 can, of course, put in blank lines if you wish, and it is probably clearer to
 do so.
 
 can, of course, put in blank lines if you wish, and it is probably clearer to
 do so.
 

+!!WARNING WARNING WARNING!!
+If there are index directives, put them after rather than before .new because
+otherwise you are likely to get an empty paragraph, which shows up as unwanted
+vertical whitespace.
+!!WARNING WARNING WARNING!!
+

 If want to mark just a few words inside a paragraph as new, you can call the
 .new macro with an argument. The macro can be called either as a directive or
 as an inline macro call, which takes the form of an ampersand followed by the
 If want to mark just a few words inside a paragraph as new, you can call the
 .new macro with an argument. The macro can be called either as a directive or
 as an inline macro call, which takes the form of an ampersand followed by the


@@ -351,4 +365,4 @@ Each such entry must be separately marked. If there are more than one or two,
 it may be easier just to mark the entire table.
 
 Philip Hazel
 it may be easier just to mark the entire table.
 
 Philip Hazel

-Last updated: 25 January 2006
+Last updated: 31 July 2006