You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general-cvs@xml.apache.org by je...@apache.org on 2003/07/15 20:28:35 UTC
cvs commit: xml-site/targets/fop/design/alt.design/properties AbstractPropertyValue.html FOAttributes.html PropNames.html Property.html PropertyConsts.html PropertyParser.html PropertySets.html PropertyTokenizer.html PropertyValue.html PropertyValueList.html ShorthandPropSets.html codedisplay.js
jefft 2003/07/15 11:28:35
Modified: targets/fop hyphenation.html hyphenation.pdf
targets/fop/design/alt.design FOPropertySets.html
FoXMLEvent.html SyncedFoXmlEventsBuffer.html
XMLNamespaces.html codedisplay.js
targets/fop/design/alt.design/properties
AbstractPropertyValue.html FOAttributes.html
PropNames.html Property.html PropertyConsts.html
PropertyParser.html PropertySets.html
PropertyTokenizer.html PropertyValue.html
PropertyValueList.html ShorthandPropSets.html
codedisplay.js
Log:
Automatic publish at Tue Jul 15 20:28:37 CEST 2003 from http://forrestbot.cocoondev.org.
Revision Changes Path
1.3 +81 -6 xml-site/targets/fop/hyphenation.html
Index: hyphenation.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/hyphenation.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- hyphenation.html 15 Jul 2003 05:07:18 -0000 1.2
+++ hyphenation.html 15 Jul 2003 18:28:34 -0000 1.3
@@ -328,18 +328,23 @@
</li>
</ul>
</li>
+<li>
+<a href="#patterns">Hyphenation Patterns</a>
+</li>
</ul>
<a name="N101BE"></a><a name="std"></a>
<h3>Standard Hyphenation Support</h3>
<div style="margin-left: 0 ; border: 2px">
-<p>FOP includes hyphenation support for the following languages:</p>
+<p>The following table summarizes FOP's standard hyphenation support.
+Please note that the "view" links reflect current CVS, and may be different than the contents of released code. See <a href="#patterns">Hyphenation Patterns</a> for a brief explanation of the contents of these files.</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">language_COUNTRY code</th>
<th colspan="1" rowspan="1">Description</th>
+ <th colspan="1" rowspan="1">View Patterns (maintenance branch CVS)</th>
</tr>
@@ -347,6 +352,7 @@
<td colspan="1" rowspan="1">en</td>
<td colspan="1" rowspan="1">English</td>
+ <td colspan="1" rowspan="1"><a target="_top" href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/hyph/en.xml?rev=1.1.2&content-type=text/vnd.viewcvs-markup">view</a></td>
</tr>
@@ -354,6 +360,7 @@
<td colspan="1" rowspan="1">es</td>
<td colspan="1" rowspan="1">Spanish</td>
+ <td colspan="1" rowspan="1"><a target="_top" href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/hyph/es.xml?rev=1.1.2&content-type=text/vnd.viewcvs-markup">view</a></td>
</tr>
@@ -361,6 +368,7 @@
<td colspan="1" rowspan="1">fi</td>
<td colspan="1" rowspan="1">Finnish</td>
+ <td colspan="1" rowspan="1"><a target="_top" href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/hyph/fi.xml?rev=1.1.2&content-type=text/vnd.viewcvs-markup">view</a></td>
</tr>
@@ -368,6 +376,7 @@
<td colspan="1" rowspan="1">hu</td>
<td colspan="1" rowspan="1">Hungarian</td>
+ <td colspan="1" rowspan="1"><a target="_top" href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/hyph/hu.xml?rev=1.1.2&content-type=text/vnd.viewcvs-markup">view</a></td>
</tr>
@@ -375,6 +384,7 @@
<td colspan="1" rowspan="1">it</td>
<td colspan="1" rowspan="1">Italian</td>
+ <td colspan="1" rowspan="1"><a target="_top" href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/hyph/it.xml?rev=1.1.2&content-type=text/vnd.viewcvs-markup">view</a></td>
</tr>
@@ -382,6 +392,7 @@
<td colspan="1" rowspan="1">pl</td>
<td colspan="1" rowspan="1">Polish</td>
+ <td colspan="1" rowspan="1"><a target="_top" href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/hyph/pl.xml?rev=1.1.2&content-type=text/vnd.viewcvs-markup">view</a></td>
</tr>
@@ -389,6 +400,7 @@
<td colspan="1" rowspan="1">pt</td>
<td colspan="1" rowspan="1">Portuguese</td>
+ <td colspan="1" rowspan="1"><a target="_top" href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/hyph/pt.xml?rev=1.1.2&content-type=text/vnd.viewcvs-markup">view</a></td>
</tr>
@@ -396,16 +408,17 @@
<td colspan="1" rowspan="1">ru</td>
<td colspan="1" rowspan="1">Russian</td>
+ <td colspan="1" rowspan="1"><a target="_top" href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/hyph/ru.xml?rev=1.1.2&content-type=text/vnd.viewcvs-markup">view</a></td>
</tr>
</table>
</div>
-<a name="N10240"></a><a name="custom"></a>
+<a name="N10281"></a><a name="custom"></a>
<h3>Custom Hyphenation Support</h3>
<div style="margin-left: 0 ; border: 2px">
-<a name="N10246"></a><a name="custom-intro"></a>
+<a name="N10287"></a><a name="custom-intro"></a>
<h4>Introduction</h4>
<div style="margin-left: 0 ; border: 2px">
<p>FOP uses an XML-based TeX-like hyphenation pattern scheme.
@@ -416,7 +429,7 @@
<div class="content">If you have access to hyphenation patterns that are licensed in an Apache-compatible way, or if you have made improvements to an existing FOP hyphenation pattern, or if you have created one from scratch, please consider contributing these to FOP so that they can benefit other FOP users as well. Please inquire on the <a href="maillist.html#fop-user">FOP User mailing list</a>.</div>
</div>
</div>
-<a name="N1025B"></a><a name="custom-license-issues"></a>
+<a name="N1029C"></a><a name="custom-license-issues"></a>
<h4>License Issues</h4>
<div style="margin-left: 0 ; border: 2px">
<p>Many of the hyphenation files distributed with TeX and its offspring are licenced under the <a target="_blank" href="http://www.latex-project.org/lppl.html">LaTeX Project Public License (LPPL)</a>, which prevents them from being distributed with Apache software.
@@ -427,12 +440,12 @@
<div class="content">The user is responsible to settle license issues for hyphenation pattern files that are obtained from non-Apache sources.</div>
</div>
</div>
-<a name="N1026C"></a><a name="custom-sources"></a>
+<a name="N102AD"></a><a name="custom-sources"></a>
<h4>Sources of Custom Hyphenation Pattern Files</h4>
<div style="margin-left: 0 ; border: 2px">
<p>The most important source of hyphenation pattern files is the <a target="_blank" href="http://www.ctan.org/tex-archive/language/hyphenation/">CTAN TeX Archive</a>.</p>
</div>
-<a name="N1027A"></a><a name="custom-install"></a>
+<a name="N102BB"></a><a name="custom-install"></a>
<h4>Installing Custom Hyphenation Patterns</h4>
<div style="margin-left: 0 ; border: 2px">
<p>To install custom a custom hyphenation pattern for use with FOP:</p>
@@ -467,6 +480,68 @@
</li>
</ol>
+</div>
+</div>
+
+<a name="N102FA"></a><a name="patterns"></a>
+<h3>Hyphenation Patterns</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>If you would like to build your own hyphenation pattern files, or modify existing ones, this section will help you understand how to do so. Even when creating a pattern file from scratch, it may be beneficial to start with an existing file and modify it. See <a href="#std">Standard Hyphenation Support</a> or the source distribution (src/hyph) for examples. Here is a brief explanation of the contents of FOP's hyphenation patterns:</p>
+<div class="frame warning">
+<div class="label">Warning</div>
+<div class="content">The remaining content of this section should be considered "draft" quality. It was drafted from theoretical literature, and has not been tested against actual FOP behavior. It may contain errors or omissions. Do not rely on these instructions without testing everything stated here. If you use these instructions, please provide feedback on the <a href="maillist.html#fop-user">FOP User mailing list</a>, either confirming their accuracy, or raising specific problems that we can address.</div>
+</div>
+<ul>
+
+<li>The root of the pattern file is the <hyphenation-info> element.</li>
+
+<li><hyphen-char> is self-explanatory: its attribute "value" contains the default character to be used for hyphenating this language. For English, this is the hyphen "-".</li>
+
+<li><hyphen-min> contains two attributes:
+ <ul>
+
+<li>before: the minimum number of characters in a word allowed to exist on a line immediately preceding a hyphenated word-break.</li>
+
+<li>after: the minimum number of characters in a word allowed to exist on a line immediately after a hyphenated word-break.</li>
+
+</ul>
+
+</li>
+
+<li><classes> contains whitespace-separated character sets.
+The members of each set should be treated as equivalent for purposes of hyphenation.
+The English patterns, for example, include sets such as "aA" and "bB" to indicate that lower case characters should be treated as equivalent to uppercase characters for purposes of computing potential hyphenation breaks.</li>
+
+<li><exceptions> contains whitespace-separated words, each of which has either explicit hyphen characters to denote acceptable breakage points, or no hyphen characters, to indicate that this word should never be hyphenated.
+Exceptions override the patterns described below.</li>
+
+<li><patterns> includes whitespace-separated patterns, which are what drive most hyphenation decisions.
+The characters in these patterns are explained as follows:
+ <ul>
+
+<li>non-numeric characters represent characters in a sub-word to be evaluated</li>
+
+<li>the period character (.) represents a word boundary, i.e. either the beginning or ending of a word</li>
+
+<li>numeric characters represent a scoring system for indicating the acceptability of a hyphen in this location. Only odd numbers represent an acceptable location for a hyphen, with 5 being most desirable, and 1 being least desirable. Even numbers indicate an unacceptable location, with zero (implied when there is no number present) being unacceptable, and 4 being extremely unacceptable.</li>
+
+</ul>
+ Here are some examples from the English patterns file:
+ <ul>
+
+<li>Knuth (<em>The TeXBook</em>, Appendix H) uses the example <strong>hach4</strong>, which indicates that it is extremely undesirable to place a hyphen after the substring "hach", for example in the word "toothach-es".</li>
+
+<li>
+<strong>.leg5e</strong> indicates that "leg-e", when it occurs at the beginning of a word, is a very good place to place a hyphen, if one is needed. Words like "leg-end" and "leg-er-de-main" fit this pattern.</li>
+
+</ul>
+ Note that the algorithm that uses this data searches for each of the word's substrings in the patterns, and chooses the <em>highest</em> value found for letter combination.
+ </li>
+
+</ul>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">An open-source utility called patgen is available on many Unix/Linux distributions to assist in creating pattern files from dictionaries. Consult man pages or the www for details.</div>
</div>
</div>
1.3 +511 -175 xml-site/targets/fop/hyphenation.pdf
<<Binary file>>
1.30 +0 -0 xml-site/targets/fop/design/alt.design/FOPropertySets.html
Index: FOPropertySets.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/FOPropertySets.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.21 +0 -0 xml-site/targets/fop/design/alt.design/FoXMLEvent.html
Index: FoXMLEvent.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/FoXMLEvent.html,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
1.21 +0 -0 xml-site/targets/fop/design/alt.design/SyncedFoXmlEventsBuffer.html
Index: SyncedFoXmlEventsBuffer.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/SyncedFoXmlEventsBuffer.html,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
1.21 +0 -0 xml-site/targets/fop/design/alt.design/XMLNamespaces.html
Index: XMLNamespaces.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/XMLNamespaces.html,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
1.20 +0 -0 xml-site/targets/fop/design/alt.design/codedisplay.js
Index: codedisplay.js
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/codedisplay.js,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/AbstractPropertyValue.html
Index: AbstractPropertyValue.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/AbstractPropertyValue.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/FOAttributes.html
Index: FOAttributes.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/FOAttributes.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/PropNames.html
Index: PropNames.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropNames.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/Property.html
Index: Property.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/Property.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/PropertyConsts.html
Index: PropertyConsts.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyConsts.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/PropertyParser.html
Index: PropertyParser.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyParser.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/PropertySets.html
Index: PropertySets.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertySets.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/PropertyTokenizer.html
Index: PropertyTokenizer.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyTokenizer.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/PropertyValue.html
Index: PropertyValue.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyValue.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/PropertyValueList.html
Index: PropertyValueList.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/PropertyValueList.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.30 +0 -0 xml-site/targets/fop/design/alt.design/properties/ShorthandPropSets.html
Index: ShorthandPropSets.html
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/ShorthandPropSets.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
1.20 +0 -0 xml-site/targets/fop/design/alt.design/properties/codedisplay.js
Index: codedisplay.js
===================================================================
RCS file: /home/cvs/xml-site/targets/fop/design/alt.design/properties/codedisplay.js,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org