groff-commit
[Top][All Lists]
Advanced

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

[groff] 01/01: Doc updates.


From: Peter Schaffter
Subject: [groff] 01/01: Doc updates.
Date: Sun, 27 Apr 2014 23:33:03 +0000

PTPi pushed a commit to branch master
in repository groff.

commit bd57dba7ea5dffde48d037d70db5099fb64927fe
Author: Peter Schaffter <address@hidden>
Date:   Sun Apr 27 19:32:40 2014 -0400

    Doc updates.
---
 contrib/mom/momdoc/definitions.html   |    9 ++++--
 contrib/mom/momdoc/docprocessing.html |   45 +++++++++++++++++++++++++++++++-
 contrib/mom/momdoc/inlines.html       |   27 +++++++++++++++----
 3 files changed, 70 insertions(+), 11 deletions(-)

diff --git a/contrib/mom/momdoc/definitions.html 
b/contrib/mom/momdoc/definitions.html
index 2cf0d8b..5d82909 100644
--- a/contrib/mom/momdoc/definitions.html
+++ b/contrib/mom/momdoc/definitions.html
@@ -318,13 +318,16 @@ or concept you&#8217;re not familiar with.
   
   <dt id="kernunit">Kern Units</dt>
   <dd>
-  A relative distance equal to 1/36 of the current
+  A relative distance, which, by default, is equal to 1/36 of the
+  current
   <a href="#ps">point size</a>.
-  Used between individual letters
-  for
+  Used between individual letters for
   <a href="#kern">kerning</a>.
   Different typesetting systems use different values (1/54 is
   popular), and sometimes call kern units by a different name.
+  It is possible to change the default size of the kern unit with the
+  <a href="inlines.html#kernunit">KERN_UNIT</a>
+  macro.
   </dd>
   
   <dt id="leading">Lead/leading</dt>
diff --git a/contrib/mom/momdoc/docprocessing.html 
b/contrib/mom/momdoc/docprocessing.html
index a044dcc..dd7dfae 100644
--- a/contrib/mom/momdoc/docprocessing.html
+++ b/contrib/mom/momdoc/docprocessing.html
@@ -119,6 +119,10 @@ class="header-link" href="#setup">Preliminary document 
setup</a></h3>
   <li><a href="#columns-intro"><b>Setting documents in columns</b></a>
   <ul class="toc-docproc">
     <li><a href="#columns">COLUMNS</a></li>
+    <li><a href="#marking-col-start">Marking the first page column start 
position</a>
+    <ul class="toc-docproc">
+      <li><a href="#col-mark">COL_MARK</a></li>
+    </ul></li>
     <li><a href="#breaking-columns">Breaking columns manually</a>
     <ul class="toc-docproc">
       <li><a href="#col-next">COL_NEXT</a> and <a 
href="#col-break">COL_BREAK</a></li>
@@ -3070,14 +3074,51 @@ always be the last document setup macro prior to
 <div class="box-tip">
 <p class="tip">
 <span class="note">Note:</span>
-Mom ignores columns completely
-when the
+Mom ignores columns completely when the
 <a href="#printstyle">PRINTSTYLE</a>
 is <kbd>TYPEWRITE</kbd>.  The notion of typewriter-style
 output in columns is just too ghastly for her to bear.
 </p>
 </div>
 
+<h3 class="docs" id="marking-col-start">Marking the first page column start 
position</h3>
+
+<p>
+If you insert or remove space after the docheader, i.e. immediately after
+<a href="#start">START</a>
+in your input file, mom needs to know where your first column begins
+in order to align subsequent columns on the first page.
+</p>
+
+<div id="col-mark" class="box-macro-args">
+Macro: <b>COL_MARK</b>
+</div>
+
+<p>
+<kbd>COL_MARK</kbd> tells mom where the first column after the
+docheader begins, in order for the top of subsequent columns on the
+first page to be aligned.  Note that if you do not manually add
+or remove space after the docheader, there is no need to invoke
+<kbd>COL_MARK</kbd>.
+</p>
+
+<div class="box-tip">
+<p class="tip">
+<span class="note">Note:</span>
+If you add or subtract space after the docheader, e.g. with
+<a href="typesetting.html#ald">ALD</a>
+or
+<a href="typesetting.html#SP">SP</a>,
+and your
+<a href="definitions.html#unitofmeasure">unit of measure</a>
+is something other than &#8220;<kbd>v</kbd>&#8221;, be sure to follow the 
spacing
+command with
+<a href="docprocessing.html#shim"><kbd>.SHIM</kbd></a>
+unless shimming has been disabled with
+<a href="#disable-shim">NO_SHIM</a>.
+</p>
+</div>
+
 <h3 class="docs">Using tabs when COLUMNS are enabled</h3>
 
 <p>
diff --git a/contrib/mom/momdoc/inlines.html b/contrib/mom/momdoc/inlines.html
index 7574dd2..d8d03bf 100644
--- a/contrib/mom/momdoc/inlines.html
+++ b/contrib/mom/momdoc/inlines.html
@@ -352,9 +352,9 @@ escapes
 <br/>
 <span class="pre-in-pp">
   \*[BU &lt;n&gt;]&nbsp;Closes the space between letters (Back Units).
-  \*[FU &lt;n&gt;]&nbsp;Opens the space between letters (Forward Units).
+  \*[FU &lt;n&gt;]&nbsp;Opens the space between letters  (Forward Units).
 </span>
-&#8220;<b>&lt;n&gt;</b>&#8221; is the number of
+<b>&lt;n&gt;</b> is the number of
 <a href="definitions.html#kernunit">kern units</a>
 by which to close or open the space between letters.
 </p>
@@ -365,10 +365,10 @@ For example,
 <span class="pre-in-pp">
   THE HUMAN COST OF COMMODIF\*[FU 1]YING FRESH W\*[BU 4]A\*[BU 5]TER
 </span>
-moves the letter Y in &#8220;COMMODIFYING&#8221; one kern unit away from
-the letter F, and the letter A in &#8220;WATER&#8221; four kern units
-closer to the letter W.  Additionally, the letter T in "WATER" is
-moved five kern units closer to the letter A.
+moves the letter Y in &#8220;COMMODIFYING&#8221; one kern unit away
+from the letter F, and the letter A in &#8220;WATER&#8221; four
+kern units closer to the letter W.  Additionally, the letter T in
+&#8220;WATER&#8221; is moved five kern units closer to the letter A.
 </p>
 
 <p>
@@ -382,6 +382,21 @@ also exist (ie with no space before the number of kern 
units desired,
 up to a limit of 36).
 </p>
 
+<p id="kernunit">
+The default size of a kern unit is 1/36 of the current point size;
+this may be changed by invoking the macro, <kbd>.KERN_UNIT</kbd>,
+with the desired value, which represents a fraction of the current
+point size.  For example, to change the kern unit to 1/54 of the
+current point size,
+<br/>
+<span class="pre-in-pp">
+  .KERN_UNIT 54
+</span>
+To restore the kern unit to its default, invoke
+<kbd>.KERN_UNIT</kbd> with an argument of <kbd>DEFAULT</kbd>.
+</p>
+
+
 <div class="box-notes">
 <h3 id="inlines-docprocessing-kerning" class="docs notes">Notes concerning 
document processing</h3>
 <p style="margin-top: .5em;">



reply via email to

[Prev in Thread] Current Thread [Next in Thread]