summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html214
1 files changed, 170 insertions, 44 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html
index a90fffe6b18..358466bbf85 100644
--- a/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html
+++ b/Master/texmf-dist/doc/latex/glossaries/mfirstuc-manual.html
@@ -4,13 +4,13 @@
<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd-->
<html xmlns="http://www.w3.org/1999/xhtml"
>
-<head><title>mfirstuc.sty v1.08: uppercasing first letter</title>
+<head><title>mfirstuc.sty v1.09: uppercasing first letter</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="TeX4ht (http://www.tug.org/tex4ht/)" />
<meta name="originator" content="TeX4ht (http://www.tug.org/tex4ht/)" />
<!-- xhtml,fn-in,css-in,uni-html4,utf8 -->
<meta name="src" content="mfirstuc-manual.tex" />
-<meta name="date" content="2014-04-04 12:03:00" />
+<meta name="date" content="2014-07-31 17:35:00" />
<style type="text/css">
<!--
@@ -34,6 +34,7 @@
.cmtt-10{font-family: monospace;}
.cmitt-10{font-family: monospace; font-style: italic;}
.cmti-10{ font-style: italic;}
+.cmbx-10{ font-weight: bold;}
p.noindent { text-indent: 0em }
td p.noindent { text-indent: 0em; margin-top:0em; }
p.nopar { text-indent: 0em; }
@@ -162,7 +163,7 @@ div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; cle
-<h2 class="titleHead">mfirstuc.sty v1.08: uppercasing first letter</h2>
+<h2 class="titleHead">mfirstuc.sty v1.09: uppercasing first letter</h2>
<div class="author" ><span
class="cmr-12">Nicola L.C. Talbot</span>
<br /> <span
@@ -171,14 +172,14 @@ class="cmr-12">Dickimaw Books</span>
href="http://www.dickimaw-books.com/" class="url" ><span
class="cmtt-12">http://www.dickimaw-_books.com/</span></a></div><br />
<div class="date" ><span
-class="cmr-12">2013-11-04</span></div>
+class="cmr-12">2014-07-30</span></div>
</div>
-<!--l. 27--><p class="indent" > The <span
-class="cmss-10">glossaries </span>bundle is supplied with the package <span
+<!--l. 28--><p class="indent" > The <span
+class="cmss-10">glossaries </span>bundle includes the package <span
class="cmss-10">mfirstuc</span><a
id="dx1-2"></a> which provides the
command:
-</p><!--l. 29--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 30--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\makefirstuc</span><span
class="cmtt-9">&#x00A0;</span></span><a
id="dx1-3"></a> <span
@@ -187,7 +188,7 @@ class="cmmi-10">&#x003C;</span><span
class="cmitt-10">stuff</span><span
class="cmmi-10">&#x003E;</span><span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 31--><p class="noindent" >
+</p><!--l. 32--><p class="noindent" >
This makes the first object of <span
class="cmmi-10">&#x003C;</span><span
class="cmti-10">stuff</span><span
@@ -195,8 +196,12 @@ class="cmmi-10">&#x003E; </span>uppercase unless <span
class="cmmi-10">&#x003C;</span><span
class="cmti-10">stuff</span><span
class="cmmi-10">&#x003E; </span>starts with a control
-sequence followed by a non-empty group, in which case the first object in the group is
-converted to uppercase. Examples: </p>
+sequence followed by a non-empty group, in which case the first object in
+the group is converted to uppercase. <span
+class="cmbx-10">No expansion is performed on the</span>
+<span
+class="cmbx-10">argument.</span>
+</p><!--l. 39--><p class="indent" > Examples: </p>
<ul class="itemize1">
<li class="itemize"><span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\makefirstuc{abc}</span></span></span> produces Abc.
@@ -214,7 +219,7 @@ class="cmtt-10">\emph</span>). Note however that
<div class="verbatim" id="verbatim-1">
\makefirstuc{{\em&#x00A0;abc}}
</div>
- <!--l. 44--><p class="nopar" > produces <span
+ <!--l. 48--><p class="nopar" > produces <span
class="cmti-10">ABC </span>(first object is <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{\em</span><span
class="cmtt-10">&#x00A0;abc}</span></span></span> so equivalent to <span class="obeylines-h"><span class="verb"><span
@@ -228,10 +233,10 @@ class="cmtt-10">&#x00A0;abc}</span></span></span>),
<div class="verbatim" id="verbatim-2">
{\makefirstuc{\em&#x00A0;abc}}
</div>
- <!--l. 49--><p class="nopar" > produces abc (<span class="obeylines-h"><span class="verb"><span
+ <!--l. 53--><p class="nopar" > produces abc (<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\em</span></span></span> doesn&#8217;t have an argument therefore first object is <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\em</span></span></span> so
- equivalent to <span class="obeylines-h"><span class="verb"><span
+class="cmtt-10">\em</span></span></span> and so
+ is equivalent to <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{\MakeUppercase{\em}abc}</span></span></span>).
</p></li>
<li class="itemize"><span class="obeylines-h"><span class="verb"><span
@@ -249,19 +254,19 @@ class="cmtt-10">\makefirstuc{{</span><span
class="cmtt-10">&auml;</span><span
class="cmtt-10">}bc}</span></span></span> produces &Auml;bc.
</li></ul>
-<!--l. 63--><p class="noindent" >Note that non-Latin or accented characters appearing at the start of the text must be
+<!--l. 67--><p class="noindent" >Note that non-Latin or accented characters appearing at the start of the text must be
placed in a group (even if you are using the <span
class="cmss-10">inputenc</span><a
id="dx1-5"></a> package) due to expansion
issues.
-</p><!--l. 67--><p class="indent" > <div class="important" title="Important Note"> In version 1.02 of <span
+</p><!--l. 71--><p class="indent" > <div class="important" title="Important Note"> In version 1.02 of <span
class="cmss-10">mfirstuc</span>, a bug fix resulted in a change in output if the first
object is a control sequence followed by an empty group. Prior to version 1.02,
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\makefirstuc{\ae{}bc}</span></span></span> produced &aelig;Bc. However as from version 1.02, it now produces
&AElig;bc. </div>
-</p><!--l. 73--><p class="noindent" >
-</p><!--l. 75--><p class="indent" > Note also that
+</p><!--l. 77--><p class="noindent" >
+</p><!--l. 79--><p class="indent" > Note also that
@@ -270,7 +275,7 @@ class="cmtt-10">\makefirstuc{\ae{}bc}</span></span></span> produced &aelig;Bc. H
\newcommand{\abc}{abc}
&#x00A0;<br />\makefirstuc{\abc}
</div>
-<!--l. 79--><p class="nopar" > produces: ABC. This is because the first object in the argument of <span
+<!--l. 83--><p class="nopar" > produces: ABC. This is because the first object in the argument of <span
class="cmtt-10">\makefirstuc </span>is
<span
class="cmtt-10">\abc</span>, so it does <span class="obeylines-h"><span class="verb"><span
@@ -283,8 +288,8 @@ class="cmtt-10">\MakeUppercase{\abc}</span></span></span>. Whereas:
\newcommand{\abc}{abc}
&#x00A0;<br />\expandafter\makefirstuc\expandafter{\abc}
</div>
-<!--l. 86--><p class="nopar" > produces: Abc. There is a short cut command which will do this:
-</p><!--l. 88--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+<!--l. 90--><p class="nopar" > produces: Abc. There is a short cut command which will do this:
+</p><!--l. 92--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\xmakefirstuc</span><span
class="cmtt-9">&#x00A0;</span></span><a
id="dx1-6"></a> <span
@@ -293,7 +298,7 @@ class="cmmi-10">&#x003C;</span><span
class="cmitt-10">stuff</span><span
class="cmmi-10">&#x003E;</span><span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 90--><p class="noindent" >
+</p><!--l. 94--><p class="noindent" >
This is equivalent to <span
class="cmtt-10">\expandafter\makefirstuc\expandafter{</span><span
class="cmmi-10">&#x003C;</span><span
@@ -309,12 +314,13 @@ So
\newcommand{\abc}{abc}
&#x00A0;<br />\xmakefirstuc{\abc}
</div>
-<!--l. 95--><p class="nopar" > produces: Abc.
-</p><!--l. 100--><p class="indent" > <div class="important" title="Important Note"> <span
-class="cmtt-10">\xmakefirstuc </span>only performs one level expansion on the first object in its
+<!--l. 99--><p class="nopar" > produces: Abc.
+</p><!--l. 104--><p class="indent" > <div class="important" title="Important Note"> <span
+class="cmtt-10">\xmakefirstuc </span>only performs one level expansion on the <span
+class="cmti-10">first </span>object in its
argument. It does not fully expand the entire argument. </div>
-</p><!--l. 104--><p class="noindent" >
-</p><!--l. 106--><p class="indent" > If you use <span
+</p><!--l. 108--><p class="noindent" >
+</p><!--l. 110--><p class="indent" > If you use <span
class="cmss-10">mfirstuc </span>without the <span
class="cmss-10">glossaries</span><a
id="dx1-7"></a> package, the standard <span
@@ -332,7 +338,7 @@ class="cmss-10">glossaries </span>package and
want to use <span
class="cmtt-10">\MakeTextUppercase</span><a
id="dx1-11"></a> instead, you can redefine
-</p><!--l. 112--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 116--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\glsmakefirstuc</span><span
class="cmtt-9">&#x00A0;</span></span><a
id="dx1-12"></a> <span
@@ -341,7 +347,7 @@ class="cmmi-10">&#x003C;</span><span
class="cmitt-10">text</span><span
class="cmmi-10">&#x003E;</span><span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 114--><p class="noindent" >
+</p><!--l. 118--><p class="noindent" >
For example:
@@ -350,12 +356,12 @@ For example:
<div class="verbatim" id="verbatim-6">
\renewcommand{\glsmakefirstuc}[1]{\MakeTextUppercase&#x00A0;#1}
</div>
-<!--l. 118--><p class="nopar" > Remember to also load <span
+<!--l. 122--><p class="nopar" > Remember to also load <span
class="cmss-10">textcase</span><a
id="dx1-13"></a> (<span
class="cmss-10">glossaries </span>loads this automatically).
-</p><!--l. 122--><p class="indent" > New to mfirstuc v1.06:
-</p><!--l. 123--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 126--><p class="indent" > New to mfirstuc v1.06:
+</p><!--l. 127--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\capitalisewords</span><span
class="cmtt-9">&#x00A0;</span></span><a
id="dx1-14"></a> <span
@@ -364,7 +370,7 @@ class="cmmi-10">&#x003C;</span><span
class="cmitt-10">text</span><span
class="cmmi-10">&#x003E;</span><span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 125--><p class="noindent" >
+</p><!--l. 129--><p class="noindent" >
This command apply <span
class="cmtt-10">\makefirstuc</span><a
id="dx1-15"></a> to each word in <span
@@ -379,7 +385,7 @@ class="cmtt-10">\space</span>. Note that no expansion is performed on
class="cmmi-10">&#x003C;</span><span
class="cmti-10">text</span><span
class="cmmi-10">&#x003E;</span>.
-</p><!--l. 132--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+</p><!--l. 136--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
class="cmtt-9">\xcapitalisewords</span><span
class="cmtt-9">&#x00A0;</span></span><a
id="dx1-16"></a> <span
@@ -388,14 +394,14 @@ class="cmmi-10">&#x003C;</span><span
class="cmitt-10">text</span><span
class="cmmi-10">&#x003E;</span><span
class="cmtt-10">} </span></div><hr>
-</p><!--l. 134--><p class="noindent" >
+</p><!--l. 138--><p class="noindent" >
This is a short cut for <span
class="cmtt-10">\expandafter\capitalisewords\expandafter{</span><span
class="cmmi-10">&#x003C;</span><span
class="cmti-10">text</span><span
class="cmmi-10">&#x003E;</span><span
class="cmtt-10">}</span>.
-</p><!--l. 138--><p class="indent" > <div class="important" title="Important Note"> If you are using <span
+</p><!--l. 142--><p class="indent" > <div class="important" title="Important Note"> If you are using <span
class="cmss-10">hyperref</span><a
id="dx1-17"></a> and want to use <span
class="cmtt-10">\capitalisewords </span>or <span
@@ -411,10 +417,11 @@ like:
</p>
<div class="verbatim" id="verbatim-7">
-Package&#x00A0;hyperref&#x00A0;Warning:&#x00A0;Token&#x00A0;not&#x00A0;allowed&#x00A0;in&#x00A0;a&#x00A0;PDF&#x00A0;string&#x00A0;(PDFDocEncoding):
+Package&#x00A0;hyperref&#x00A0;Warning:&#x00A0;Token&#x00A0;not&#x00A0;allowed&#x00A0;in&#x00A0;a&#x00A0;PDF&#x00A0;string
+&#x00A0;<br />(PDFDocEncoding):
&#x00A0;<br />(hyperref)&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;removing&#x00A0;&#8216;\capitalisewords&#8217;
</div>
-<!--l. 146--><p class="nopar" > If you want to provide an alternative for the PDF bookmark, you can use
+<!--l. 151--><p class="nopar" > If you want to provide an alternative for the PDF bookmark, you can use
<span
class="cmss-10">hyperref</span><a
id="dx1-19"></a>&#8217;s <span
@@ -423,8 +430,8 @@ class="cmtt-10">\texorpdfstring</span><a
class="cmss-10">hyperref</span><a
id="dx1-21"></a> manual for further details.
</div>
-</p><!--l. 150--><p class="noindent" >
-</p><!--l. 152--><p class="indent" > Examples:
+</p><!--l. 155--><p class="noindent" >
+</p><!--l. 157--><p class="indent" > Examples:
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-23x1">
@@ -434,7 +441,7 @@ class="cmss-10">hyperref</span><a
<div class="verbatim" id="verbatim-8">
\capitalisewords{a&#x00A0;book&#x00A0;of&#x00A0;rhyme.}
</div>
- <!--l. 157--><p class="nopar" > produces: A Book Of Rhyme.
+ <!--l. 162--><p class="nopar" > produces: A Book Of Rhyme.
</p></li>
<li
class="enumerate" id="x1-25x2">
@@ -444,7 +451,7 @@ class="cmss-10">hyperref</span><a
<div class="verbatim" id="verbatim-9">
\capitalisewords{a&#x00A0;book\space&#x00A0;of&#x00A0;rhyme.}
</div>
- <!--l. 164--><p class="nopar" > produces: A Book of Rhyme.
+ <!--l. 169--><p class="nopar" > produces: A Book of Rhyme.
</p></li>
<li
class="enumerate" id="x1-27x3">
@@ -455,7 +462,7 @@ class="cmss-10">hyperref</span><a
\newcommand{\mytitle}{a&#x00A0;book\space&#x00A0;of&#x00A0;rhyme.}
&#x00A0;<br />\capitalisewords{\mytitle}
</div>
- <!--l. 172--><p class="nopar" > produces: A BOOK OF RHYME. (No expansion is performed on <span
+ <!--l. 177--><p class="nopar" > produces: A BOOK OF RHYME. (No expansion is performed on <span
class="cmtt-10">\mytitle</span>, so
<span
class="cmmi-10">&#x003C;</span><span
@@ -471,9 +478,128 @@ class="cmmi-10">&#x003E; </span>consists of just one &#8220;word&#8221;.) Compar
\newcommand{\mytitle}{a&#x00A0;book\space&#x00A0;of&#x00A0;rhyme.}
&#x00A0;<br />\xcapitalisewords{\mytitle}
</div>
- <!--l. 183--><p class="nopar" > produces: A Book of Rhyme.
+ <!--l. 188--><p class="nopar" > produces: A Book of Rhyme.
</p>
</li></ol>
+<!--l. 194--><p class="indent" > As from v1.09, you can specify words which shouldn&#8217;t be capitalised unless they
+occur at the start of <span
+class="cmmi-10">&#x003C;</span><span
+class="cmti-10">text</span><span
+class="cmmi-10">&#x003E; </span>using:
+</p><!--l. 196--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+class="cmtt-9">\ttfamily</span><span
+class="cmtt-9">&#x00A0;</span></span><a
+ id="dx1-30"></a><span
+class="cmtt-10">\MFUnocap{</span><span
+class="cmmi-10">&#x003C;</span><span
+class="cmti-10">word</span><span
+class="cmmi-10">&#x003E;</span><span
+class="cmtt-10">} </span></div><hr>
+</p><!--l. 198--><p class="noindent" >
+This only has a local effect. The global version is:
+</p><!--l. 200--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+class="cmtt-9">\ttfamily</span><span
+class="cmtt-9">&#x00A0;</span></span><a
+ id="dx1-31"></a><span
+class="cmtt-10">\gMFUnocap{</span><span
+class="cmmi-10">&#x003C;</span><span
+class="cmti-10">word</span><span
+class="cmmi-10">&#x003E;</span><span
+class="cmtt-10">} </span></div><hr>
+</p><!--l. 202--><p class="noindent" >
+</p><!--l. 204--><p class="indent" > For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-12">
+\capitalisewords{the&#x00A0;wind&#x00A0;in&#x00A0;the&#x00A0;willows}
+&#x00A0;<br />\MFUnocap{in}%
+&#x00A0;<br />\MFUnocap{the}%
+&#x00A0;<br />\capitalisewords{the&#x00A0;wind&#x00A0;in&#x00A0;the&#x00A0;willows}
+</div>
+<!--l. 212--><p class="nopar" > produces: <spacer type=vertical size=10><span class="obeylines-h">
+ <br />The Wind In The Willows
+ <br />The Wind in the Willows
+ <br /><spacer type=vertical size=10></span>
+The list of words that shouldn&#8217;t be capitalised can be cleared using
+</p><!--l. 223--><p class="indent" > <hr><div title="Definition"><span class="marginpar"><span
+class="cmtt-9">\MFUclear</span><span
+class="cmtt-9">&#x00A0;</span></span><a
+ id="dx1-32"></a> <span
+class="cmtt-10">\MFUclear </span></div><hr>
+</p><!--l. 225--><p class="noindent" >
+</p><!--l. 227--><p class="indent" > The package <span
+class="cmss-10">mfirstuc-english</span><a
+ id="dx1-33"></a> loads <span
+class="cmss-10">mfirstuc</span><a
+ id="dx1-34"></a> and uses <span
+class="cmtt-10">\MFUnocap </span>to add common
+English articles and conjunctions, such as &#8220;a&#8221;, &#8220;an&#8221;, &#8220;and&#8221;, &#8220;but&#8221;. You may want to
+add other words to this list, such as prepositions, but as there&#8217;s some dispute over
+whether prepositions should be capitalised, I&#x00A0;don&#8217;t intend to add them to this
+package.
+</p><!--l. 234--><p class="indent" > If you want to write a similar package for another language, all you need to do is
+create a file with the extension <span
+class="cmtt-10">.sty </span>that starts with
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-13">
+\NeedsTeXFormat{LaTeX2e}
+</div>
+<!--l. 239--><p class="nopar" > The next line should identify the package. For example, if you have called the file
+<span
+class="cmtt-10">mfirstuc-french.sty </span>then you need:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-14">
+\ProvidesPackage{mfirstuc-french}
+</div>
+<!--l. 244--><p class="nopar" > It&#8217;s a good idea to also add a version in the final optional argument, for example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-15">
+\ProvidesPackage{mfirstuc-french}[2014/07/30&#x00A0;v1.0]
+</div>
+<!--l. 249--><p class="nopar" > Next load <span
+class="cmss-10">mfirstuc</span><a
+ id="dx1-35"></a>:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-16">
+\RequirePackage{mfirstuc}
+</div>
+<!--l. 253--><p class="nopar" > Now add all your <span
+class="cmtt-10">\MFUnocap </span>commands. For example:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-17">
+\MFUnocap{de}
+</div>
+<!--l. 257--><p class="nopar" > At the end of the file add:
+
+
+
+</p>
+ <div class="verbatim" id="verbatim-18">
+\endinput
+</div>
+<!--l. 261--><p class="nopar" >
+</p><!--l. 263--><p class="indent" > Put the file somewhere on <span class="TEX">T<span
+class="E">E</span>X</span>&#8217;s path, and now you can use this package in your
+document. You might also consider uploading it to CTAN in case other users find it
+useful.
+</p>
</body></html>