diff options
author | Karl Berry <karl@freefriends.org> | 2010-04-15 17:06:54 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2010-04-15 17:06:54 +0000 |
commit | b96443cad2d528aab786260f3a4a30ff1c6d94c1 (patch) | |
tree | b6b3e7cb0e060c6c6cfa3dac9a41e2d24c29297d /Master/texmf-dist/doc/latex/philex | |
parent | 440f3a0a24a2061ba24309a1c5538be6ecd4e74a (diff) |
philex update (14apr10)
git-svn-id: svn://tug.org/texlive/trunk@17879 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/philex')
-rw-r--r-- | Master/texmf-dist/doc/latex/philex/README | 10 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/philex/philex.pdf | bin | 88528 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/philex/philex.tex | 156 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/philex/philexmanualb.pdf | bin | 0 -> 215518 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/philex/philexmanualb.tex | 422 |
5 files changed, 422 insertions, 166 deletions
diff --git a/Master/texmf-dist/doc/latex/philex/README b/Master/texmf-dist/doc/latex/philex/README deleted file mode 100644 index 9b57b1a42db..00000000000 --- a/Master/texmf-dist/doc/latex/philex/README +++ /dev/null @@ -1,10 +0,0 @@ -Readme -philex is a package for creating and cross-referencing named or numbered environments, such as equations, example sentences as in linguistics or philosophy, and named principles. philex offers dynamic cross-references not only the numbers of labeled environments, but also to short names of environments, and to the contents of those environment. Cross-referencing works forward as well as backward in the text. - -philex builds upon Wolfgang Sternefelds linguex package, designed for example sentences in linguistics (as well as for adding phrase structure brackets and glosses). linguex provides the basic formatting, numbering in several levels, and naming capacity. - -philex adds some extra formatting and numbering options to linguex, over and above the cross-referencing features. - -philex.sty is to be placed in the LaTeX-folder of the texmf-tree. A short manual is provided, together with its .tex source. It requires the linguex package as well as the calc package. - -This material is subject to the LaTeX Project Public License. See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html for the details of that license.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/philex/philex.pdf b/Master/texmf-dist/doc/latex/philex/philex.pdf Binary files differdeleted file mode 100644 index a14f660bcee..00000000000 --- a/Master/texmf-dist/doc/latex/philex/philex.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/philex/philex.tex b/Master/texmf-dist/doc/latex/philex/philex.tex deleted file mode 100644 index 1844c8aac29..00000000000 --- a/Master/texmf-dist/doc/latex/philex/philex.tex +++ /dev/null @@ -1,156 +0,0 @@ -\documentclass[10pt]{article} -\usepackage[utf8]{inputenc} - - - -\usepackage{linguex,philex} - - - -\newcommand{\qut}[1]{`#1'} -\usepackage[english]{babel} - -\usepackage{latexsym,amssymb,amsmath,amsthm,wasysym} -\usepackage{calc} - -\newcounter{hour} -\newcounter{minute} - - - -\newcommand{\emp}{\emph} -\newcommand{\note}{\footnote} -\setcounter{hour}{\time/60} -\setcounter{minute}{\time-60*\thehour} -\ifnum\thehour<10 \def\nowh{0\thehour} \else \def\nowh{\thehour}\fi -\ifnum\theminute<10\def\nowm{0\theminute} \else \def\nowm{\theminute}\fi -\def\now{\nowh:\nowm} -\def\aut{Peter Pagin\\ peter.pagin@philosophy.su.se} -\def\home{\begin{flushright} -\item Department of Philosophy -\item Stockholm University -\item peter.pagin@philosophy.su.se -\end{flushright}} - - -\begin{document} -\title{The \tt philex \rm Package \\ version 0.6} -\author{\aut} -\date{\today, \now} -\maketitle -\settowidth{\Exlabelwidth}{(110)} - -\subsection*{Changes since version 0.5} -Corrected vertical spacing between adjacent \verb+\lb+ and \verb+\lbp+ environments. - -\subsection*{Changes since version 0.3} -In version 0.3, forward cross-reference was effected by means of writing command definitions to a separate file, \emp{myfile}-px.tex, which was subsequently read-in at the beginning of the following run of typesetting. In version 0.5 the information is instead written to the .aux file and then read from the .aux file in the subsequent run. This method is more elegant and eliminates problems with the implementation of the old method. The improvement is due entirely to Robin Fairbairns. - -\subsection*{Manual} -The \verb+philex+ package is a small addition to Wolfgang Sternefeld's \verb+linguex+ package and requires \verb+linguex+. As of version 0.2 it also requires \verb+calc+. \verb+philex+ will load \verb+linguex+ if it is installed. The purpose of \verb+philex+ is to add functions for more flexible cross-referencing, for repeating and embedding named or numbered sentences and also a little bit for formatting. - -As of version 0.5 \verb+philex+ writes cross-ref information to the .aux file and reads that information at beginning of the subsequent run of typesetting. This allows forward cross-referencing to environments that are named or numbered+named, such as \rf{clauses} on p. \pageref{clauses}, in analogy to the label-reference system of LaTeX itself. - -\verb+philex+ is called by \verb+\usepackage{philex}+. Its basic command is \verb+\lb{}{}+, which takes two obligatory arguments. The first argument is the label of the sentence, and the second is the sentence itself. \verb+lb+ uses the \verb+\ex.+ formatting of \verb+linguex+, and thereby the \verb+ExNo+ counter. Type - -\begin{verbatim} -\lb{nice}{This is a nice day} -\end{verbatim} -and the result will be - -\lb{nice}{This is a nice day} -in case it is numbered sentence no \rn{nice} in your document (we will return in a second to the full stop issue). - -In \verb+linguex+ you leave a blank line after sentence to close the environment. The blank line gives a \verb+\par+-command to TeX. In \verb+philex+ the \verb+\par+-command is built into the top-level environments. So you leave a blank line after an \verb+\lb{}{}+-environment only if you want to start a new paragraph. The reason for this change, is that only this way will the \verb+philex+ package work together with the \verb+extract+ package by Hendri Adriaens, which can be used for extracting material, e.g. for generating a handout, from documents making use of \verb+philex+. \verb+linguex+ comes together with Sternefeld's \verb+linguho+ package, which has the function of generating a handout from documents using \verb+linguex+. \verb+linguho+ does not work with \verb+philex+, since the \verb+linguex+ environments are not explicit in the document. The corresponding function, only more flexible, can be served with the \verb+extract+ package. - -For cross-referencing a numbered sentence you can use to ordinary \verb+\ref{}+-command, or the command \verb+\rf{}+ provided by \verb+philex+. Thus \verb+\rf{nice}+ produces the \verb+ExNo+ number of \rf{nice}. The command takes an optional argument. In case you want to add a suffix in the cross-reference, you provide it as the optional argument. \verb+\rf[a]{nice}+ produces \qut{\rf[a]{nice}}. This is normally not needed, since the usual reasons for doing this are accommodated by other means (see below). - -A cross-reference with \verb+\rn{}+ will remove the brackets. \verb+\rn{nice}+ gives \qut{\rn{nice}}. This is equivalent to using the label itself as a command name: \verb+\nice+ gives \qut{\nice}. - -You might want to repeat the sentence later. This can be done with the \verb+\rp{}+-command. Thus \verb+\rp{nice}+ produces \qut{\rp{nice}}. With the \verb+\ml{}+-command you can repeat the sentence with the initial letter made lowercase: \verb+\ml{nice}+ produces \qut{\ml{nice}}. This is useful in case you want to embed the sentence in a larger sentence, such as - -\lb{great}{Elsa thinks that \ml{nice}, but Alfred does not} -This also illustrates the insertion of the full stop. You do not normally type in a full stop a the end of the named sentence, but let it be put in by the \verb+\lb+-command. This makes the call by means of the \verb+\ml+-command fully embeddable. The full-stop insertion can be turned off with \verb+\q+ and turned on again with \verb+\s+, and also transformed into a comma with \verb+\km+. These commands shall go before the relevant \verb+philex+ environment. The analogous functions for the first subordinate level are served by \verb+\qt+ (changing to nothing), \verb+\stp+ (changing to full stop), and \verb+\kmt+ (changing to comma). - -In case you want to repeat the sentence with its name or number you can use \verb+\rff{}+. \verb+\rff{nice}+ produces \rff{nice} - -In many cases you will want to produce a variant of the original sentence, which will have the same name or number as the original, but with an added suffix, like a letter or a prime symbol. This is achieved with the \verb+\lbu{}{}{}{}+-command. It takes four obligatory arguments. The first is the label of the new sentence, the second is the label of the sentence you are giving a variant of, the third is the suffix you want to add, and the fourth is the new sentence itself. -\begin{verbatim} -\lbu{nicy}{nice}{\('\)}{But that was even nicer} -\end{verbatim} -produces \lbu{nicy}{nice}{\('\)}{But that was even nicer} -And a cross-reference will preserve the name: \verb+\rf{nicy}+ produces \qut{\rf{nicy}}. - -You will also want to have named principles, such as in \rf{life} \emp{below} (exemplifying forward cross-reference) -\lbp{life}{W}{Life is wonderful!} -These are produced with the \verb+\lbp{}{}{}+-command which makes use of the optional argument to \verb+\ex.[]+ in \verb+linguex+. Cross-references with \verb+\rf+, like to \rf{life}, and updates with \verb+\lbu+, like - -\lbu{newlife}{life}{\textsuperscript{+}}{\q Life is terrific!} work as before. If you later change the name of the principle, or the formulation, the changes are reflected in the cross-references and repetitions after the next typesetting, as long as you do not change the labels. In the last example, the full stop function was turned off by means of \verb+\q+ inside the last argument, so as not to produce an extra full stop after the exclamation mark. - -In case you don't want the brackets in the principle name, turn them off with \verb+\broff+, as in \rn{offer}:\broff -\lbp{offer}{L}{Has a lot to offer!} -To turn them on again, type \verb+\bron+. \bron It is also possible to change the brackets with \verb+\renewcommand{\lebrack}{}+ and \verb+\renewcommand{\ribrack}{}+ (put in what you want), for the left and right bracket, respectively. - -The cross-reference and repeat and update functions also work for subordinate clauses, corresponding to \verb+\a.+ and \verb+\b.+ of \verb+linguex+. For these purposes, \verb+philex+ has \verb+\lba{}{}+, \verb+\lbb{}{}+ and \verb+\lbz{}{}+. To illustrate, the code - -\begin{verbatim} -\lbp{clauses}{PP}{Some main words, followed by -\lba{first}{Time flies} \lbb{second}{Like an arrow} -\lbz{last}{And much too fast}} -\end{verbatim} -produces - -\lbp{clauses}{PP}{Some main words, followed by -\lba{first}{Time flies} \lbb{second}{Like an arrow} \lbz{last}{And much too fast}} -It is in general not necessary to to switch from \verb+\lbb+ to \verb+\lbz+ for the last subordinate clause. - -Notice that the subordinate environments are put \emp{into} the main \verb+\lbp+ environment. This is necessary, since the main environment has a \verb+\par+ command built in, which ends the \verb+\ex.+ environment of \verb+linguex+. Also, there are no line-breaks in the code (even though that cannot be seen above), and that is again for the sake of the \verb+extract+ package, which extracts given command environments by command line. In these subordinate environments the full stop is put in. The closing one, \verb+\lbz+, turns off the the full stop that may come from the the main environment, so as not to produce doubles. - -We can now cross-reference a subordinate clause, as with \verb+\rf{second}+, to produce \qut{\rf{second}}. We can also repeat, as with \verb+\rff{last}+: \rff{last} -Similarly update. - -There are some formatting options. The command \verb+\subformat{}{}{}+ takes three arguments. With the first argument you can control the numbering format. Default is lowercase alphabetic. Setting the first argument to \qut{A} gives uppercase alphabetic, to \qut{r} gives lowercase roman, to \qut{R} gives uppercase roman, and to \qut{1} gives arabic. Other argument values have no effect. The second argument controls the prefix. For instance, inserting a left bracket will produce left-bracket enumeration. The last argument produces the suffix. So, \verb+\sub{1}{}{)}+ will produce arabic enumeration with a closing bracket after the numeral. The \verb+\subformat+-command should be put in before the first \verb+\lba+-command. - -There are some shorter fast-switching commands for this purpose: \verb+\sa+ produces lowercase alphabetic with dot (which is \verb+linguex+ default), \verb+\sab+ produces lowercase alphabetic followed by right bracket, and \verb+\sr+ produces lowercase roman followed by right bracket. If these commands, just as the -verb+\subformat+-command, are put within the main\verb+philex+ environment (before the first subordinate clause), the changes are only local to that environment. Note that the longer command works by \emp{redefining} the \verb+\alph+-command which normally gives lowercase alphabetic, while the fast switching commands redefine \verb+\theSubExNO+ without redefining \verb+\alph+. So if \verb+\alph+ is locally redefined to mean \verb+\roman+, the command \verb+\sa+ will produce a roman numeral with dot in that local context. - -Repeating an \verb+\lba+ command after a subordinate clause produces a new subordinate level, as designed in \verb+linguex+. We can have - -\lb{numclauses}{Much to do \subformat{a}{}{)}\lba{more}{So little time}\lba{late}{And one is always late}} -Clause \rf{late} is worth thinking about. Produced with the following code: -\begin{verbatim} -\lb{numclauses}{Much to do \subformat{a}{}{)} -\lba{more}{So little time} -\lba{late}{And one is always late}} -Clause \rf{late} is worth thinking about. -\end{verbatim} -Some formatting of the second subordinate level can be done by means of \verb+\subsubformat{}{}{}+. At present, however, only the second and third argument, controlling prefix and suffix, are operative. The enumeration style is not affected. - -In case you wish a list of independently numbered principles with a shared name stem, use one of the \verb+\lbpx+-commands, where \verb+x+ is one of \verb+a,b,c,d+. It takes two arguments, for label and content sentence. You first set the enumeration style and and the stem with \verb+\bpxformat{}{}+, where again \verb+x+ has the corresponding value. The first argument sets the numbering style, as above, and the second the stem. Then the \verb+\lbpx+-command picks it up: \bpaformat{1}{T} - -\begin{verbatim} -\bpaformat{1}{T} -\lbpa{kno}{Alfred is in the know.} -\lbpa{hu}{Elsa is, too.} -\lbpa{kne}{John agrees.} -\end{verbatim} -produces -\lbpa{kno}{Alfred is in the know.} \lbpa{hu}{Elsa is, too.} \lbpa{kne}{John agrees.} -These enumerations are independent of \verb+ExNO+ and of each other, and the counters (\verb+bpx+) are reset with the relevant \verb+\bpxformat+. They still work with sub-clauses, cross-references and the rest of the apparatus. Note that these enumerations do not have to be contiguous: \lbpa{glufs}{But he shouldn't.} - -The top-level commands, \verb+\lb+, \verb+\lbp+, \verb+\lbpx+, and \verb+\lbu+, take an optional argument. If that argument is set to \qut{c}, as in \verb+\lb[c]{xx}{yy}+, the content sentence will be centered, as in - -\lb[c]{PoC}{\[P(\gamma (t)\geq\delta)|\textbf{A})=(0.5)^{\alpha (t)}\sum_{i=0}^{\epsilon(t)}\binom{\alpha(t)}{i}\]} -This is designed for equations and figures. It works both with \verb+\(\)+ and, as here, with \verb+\[\]+, which produces more space above and below. - -Positioning text (left, center or right) on lower lines in a \verb+philex+-environment can be done by means of line-break and a \verb+\makebox[][]{}+-command on the new line. The first optional argument sets the width of the box. With the command \verb+\hcentro+, provided by \verb+philex+, the length is set to \verb+\textwidth+ (the current width of the entire text column) minus the \verb+linguex+ inset (width of the label + with of the separation between label and text). The length command \verb+\centro+ deducts that quantity twice. This second alternative is used for centering with respect to the entire text column (exemplifed in \rf{PoC} above), while the \verb+\hcentro+ command is used for left-, center- or right positioning within the interior text column of \verb+philex/linguex+. The positioning is chosen by the \LaTeX values \verb+l+, \verb+c+ and \verb+r+ in the second optional argument. - -Finally, \verb+philex+ provides an additional counter, \verb+bna+, for informal enumerations in the main text. The command \verb+\bn+ advances the counter and puts in a number with a quad space. The command \verb+\bns+ resets the counter to zero. - -\bn The result is exemplified with first with this sentence. - -\bn And then it is followed up here. - -There are more possibilities in \verb+linguex+, described in its manual. - - -\end{document}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/philex/philexmanualb.pdf b/Master/texmf-dist/doc/latex/philex/philexmanualb.pdf Binary files differnew file mode 100644 index 00000000000..5f62e9a54f0 --- /dev/null +++ b/Master/texmf-dist/doc/latex/philex/philexmanualb.pdf diff --git a/Master/texmf-dist/doc/latex/philex/philexmanualb.tex b/Master/texmf-dist/doc/latex/philex/philexmanualb.tex new file mode 100644 index 00000000000..d9171ad4b4c --- /dev/null +++ b/Master/texmf-dist/doc/latex/philex/philexmanualb.tex @@ -0,0 +1,422 @@ +\documentclass[10pt]{article} +\usepackage[utf8]{inputenc} + + +\usepackage{linguex,eqparbox} +\usepackage[oldpunct,hyper]{philex} +\usepackage[left=6cm,right=4cm,top=4cm,bottom=5cm]{geometry} +\usepackage[colorlinks,linkcolor=black,bookmarksnumbered]{hyperref} + +\newcommand{\qut}[1]{`#1'} +\usepackage[english]{babel} + +\usepackage{latexsym,amssymb,amsmath,amsthm,wasysym} +\usepackage{calc} + +\newcounter{hour} +\newcounter{minute} + + + +\newcommand{\emp}{\emph} +\newcommand{\note}{\footnote} +\setcounter{hour}{\time/60} +\setcounter{minute}{\time-60*\thehour} +\ifnum\thehour<10 \def\nowh{0\thehour} \else \def\nowh{\thehour}\fi +\ifnum\theminute<10\def\nowm{0\theminute} \else \def\nowm{\theminute}\fi +\def\now{\nowh:\nowm} +\def\aut{Peter Pagin\\ peter.pagin@philosophy.su.se} +\def\home{\begin{flushright} +\item Department of Philosophy +\item Stockholm University +\item peter.pagin@philosophy.su.se +\end{flushright}} + + +\begin{document} +\tracingassigns=3 +\title{The \tt philex \rm Package \\ version 1.0} +\author{\aut} +\date{\today, \now} +\maketitle +\reversemarginpar +\setlength{\marginparwidth}{3cm} +\subsection*{Changes since version 0.9 (internal version)} +-- \quad Adapted the package to version 4.1 of \verb+linguex+.\\ +-- \quad Added two commands for label separation. + +\subsection*{Changes since version 0.6} +-- \quad Added support for \verb+hyperref+ for named environments.\\ +\noindent -- \quad Added naming options for sub-environments (\verb+\lba+, \verb+\lbb+, \verb+\lbz+).\\ +\noindent -- \quad Added customizing of brackets and numbering-style for second-level sub-environments.\\ +\noindent -- \quad Corrected errors in vertical spacing for \verb+\lbu+ and \verb+\rff+.\\ +\noindent -- \quad Corrected an error in the centering option, and added an alternative for centering.\\ +\noindent -- \quad Replaced earlier (overly short) punctuation commands, and added a package option for using the old commands.\\ +\noindent -- Added customizing of vertical spacing and horizontal spacing as well as label length.\\ +\noindent -- \quad Made the \verb+\lbpx+ environments labels more customizable.\\ +\noindent -- \quad Rewrote and reorganized the manual. + +\subsection*{Changes since version 0.5} +Corrected vertical spacing between adjacent \verb+\lb+ and \verb+\lbp+ environments. + +\subsection*{Changes since version 0.3} +In version 0.3, forward cross-reference was effected by means of writing command definitions to a separate file, \emp{myfile}-px.tex, which was subsequently read-in at the beginning of the following run of typesetting. In version 0.5 the information is instead written to the .aux file and then read from the .aux file in the subsequent run. This method is more elegant and eliminates problems with the implementation of the old method. The improvement is due to Robin Fairbairns. + + + +\section*{Manual} +The \verb+philex+ package is intended for use in topics such as philosophy and linguistics, where there is a need both of many example sentences and of named principles, and of cross-references to them in the text. Sometimes one wants cross-reference to environment numbers (or prefix plus number), sometimes to a non-numbered named environment, and sometimes to the content of the environment, for repeating the content in running text or in another environment. The package is a small addition to Wolfgang Sternefeld's \verb+linguex+ package and requires \verb+linguex+. As of version 0.2 it also requires \verb+calc+. \verb+philex+ will load \verb+linguex+ if it is installed. The purpose of \verb+philex+ is to add functions for more flexible cross-referencing, for repeating and embedding named or numbered environments, \verb+hyperref+ support and a some further formatting options. + +As of version 0.5 \verb+philex+ writes cross-ref information to the .aux file and reads that information at the beginning of the subsequent run of typesetting. This allows forward cross-referencing to environments that are named or numbered+named, such as \rf{clauses} on p. \pageref{clauses}, +in analogy to the label-reference system of LaTeX itself. As of version 0.9 hyperlinks produced by \verb+hyperref+ are created also for named environments with the \verb+<hyper>+ package option. + +\section{Calling the package} +\verb+philex+ is \marginpar{\tt philex} called by adding \verb+\usepackage[<package options>]{philex}+ in the preamble. This will also automatically load the \verb+linguex+ package. If \verb+linguex+ is called separately, it should be called \emp{before} \verb+philex+, since \verb+philex+ (marginally) redefines some commands in \verb+linguex+. + +\section{Package options} +With \marginpar{\tt <hyper>} the \verb+<hyper>+ option hyperlinks will be created by cross-references to named environments (such as \verb+\lbp+). This requires that the \verb+hyperref+ package is called (should be called last). If \verb+hyperref+ is called without the \verb+<hyper>+ option, hyperlinks will anyway be created from the usual \verb+philex+ cross-references that make use of the basic label- and cross-reference function in LaTeX. + +With the \verb+<oldpunct>+ package option \marginpar{\tt <oldpunct>} the old punctuation commands (see below) will still work. This is for the purpose of using more recent versions of \verb+philex+ with older files, without needing search-and-replace. + +\section{Top-level environments} +The basic environment command of \verb+philex+ is \marginpar{\tt \(\backslash\)lb} \verb+\lb{}{}+. It takes two obligatory arguments. The first argument is the label of the environment, and the second is the content of the environment itself. \verb+lb+ uses the \verb+\ex.+ formatting of \verb+linguex+, and thereby the \verb+ExNo+ counter. Type + +\begin{verbatim} +\lb{nice}{This is a nice day. \\ Not too hot.} +\end{verbatim} +and the result will be + +\lb{nice}{This is a nice day.\\ Not too hot.} +in case it is the first \verb+\lb+-environment in your document. + +In \verb+linguex+ you leave a blank line after sentence to close the environment. The blank line gives a \verb+\par+-command to TeX. In \verb+philex+ the \verb+\par+-command is built into the top-level environments. So you leave a blank line after an \verb+\lb{}{}+-environment only if you want to start a new paragraph. The reason for this change is that only this way will the \verb+philex+ package work together with the \verb+extract+ package by Hendri Adriaens, which can be used for extracting material, e.g. for generating a handout, from documents making use of \verb+philex+. \verb+linguex+ comes together with Sternefeld's \verb+linguho+ package, which has the function of generating a handout from documents using \verb+linguex+. \verb+linguho+ does not work with \verb+philex+, since the \verb+linguex+ environments are not explicit in the document. The corresponding function, only more flexible, can be served with the \verb+extract+ package. + +In many cases you \marginpar{Update with \tt\(\backslash\)lbu}will want to produce a variant of the original sentence, which will have the same name or number as the original, but with an added suffix, like a letter or a prime symbol. This is achieved with the \verb+\lbu{}{}{}{}+-command. It takes four obligatory arguments. The first is the label of the new sentence, the second is the label of the environment you are giving a variant of, the third is the suffix you want to add, and the fourth is the new content itself. +\begin{verbatim} +\lbu{nicy}{nice}{\('\)}{But that yesterday was even nicer.} +\end{verbatim} +produces \lbu{nicy}{nice}{\('\)}{But yesterday was even nicer.} + +You may also want to \marginpar{Named environments with \tt\(\backslash\)lbp} have named principles, such as in \rf{life} below (exemplifying forward cross-reference) \bron +\lbp{life}{W}{Life is wonderful!} +These are produced with the \verb+\lbp{}{}{}+-command which makes use of the optional argument to \verb+\ex.[]+ in \verb+linguex+. If you later change the name of the principle, or the formulation, the changes are reflected in the cross-references and repetitions after the next typesetting, as long as you do not change the labels. + +And updates with \verb+\lbu+, like + +\lbu{newlife}{life}{\textsuperscript{+}}{\q Life is terrific!} +work as before. + +In case you \marginpar{Prefixed numbering with \tt\(\backslash\)lbpx} wish a list of independently numbered principles with a shared name stem, there are four independent series. Use one of the \verb+\lbpx+-commands, where \verb+x+ is one of \verb+a,b,c,d+. You can format the listing with \verb+\bpxformat{}{}{}+, where again \verb+x+ has the corresponding value. The first argument sets the numbering style (see below), the second the prefix and the third argument the suffix (this is a change since version 0.6, where there was no suffix argument, and general bracket commands were used). + Then the \verb+\lbpx+-command picks it up: \bpaformat{1}{(T}{)} + +\begin{verbatim} +\bpaformat{1}{(T}{)} +\lbpa{kno}{John is in the know.} +\lbpa{hu}{Elsa is, too.} +\lbpa{kne}{Alfred agrees.} +\end{verbatim} +produces +\lbpa{kno}{John is in the know.} +\lbpa{hu}{Elsa is, too.} +\lbpa{kne}{Alfred agrees.} +These enumerations are independent of \verb+ExNO+ and of each other, and the counters (\verb+bpx+) are reset with the relevant \verb+\bpxformat+. They still work with sub-clauses, cross-references and the rest of the apparatus. Note that these enumerations do not have to be contiguous: + +\lbpa{glufs}{But he shouldn't.} + +All the top-level \marginpar{Centering} environments take an optional argument \verb+[c]+ for centering the text. \verb+\lb[c]{compo}{\[\mu(\sigma(t_{1},\ldots, t_{n}))=+ \verb+r_{\sigma}(\mu(t_{1}), \ldots, \mu(t_{n}))\]}+ produces + +\lb[c]{compo}{\[\mu(\sigma(t_{1},\ldots, t_{n}))=r_{\sigma}(\mu(t_{1}), \ldots, \mu(t_{n}))\]} + In this example a displaymath environment (\verb+\[..\]+ or \verb+$$..$$+) has been used. This produces extra vertical space above and below, suitable for equations. With centering and in-line math environment (\verb+\(..\)+ or \verb+$..$+), no extra vertical space is produced. + + +The default for \verb+philex+ is centering in the entire column, i.e. along \verb+\columnwidth+. As an alternative, you can make \verb+philex+ center the text within the \verb+philex+ text area itself. This puts the text slightly more to the right. To achieve this, give the command \verb+\narrowcenter+ before the relevant environment. To later revert to the default option, give the command \verb+\widecenter+. + +Horizontal alignment \marginpar{Alignment} can be easily achieved by means of Scott Pakin's recent elegant \verb+eqparbox+ package. The code + +\begin{verbatim} +\lb{alignthis}{\eqmakebox[hit][l]{\(2+3\)} \quad = \quad \(5\) \\ +\eqmakebox[hit][l]{\(2+3+4\)} \quad = \quad \(9\)} +\end{verbatim} + automatically generates alignment after a second round of typesetting, without the need of an equation align environment: + +\lb{alignthis}{\eqmakebox[hit][l]{\(2+3\)} \quad = \quad \(5\) \\ +\eqmakebox[hit][l]{\(2+3+4\)} \quad = \quad \(9\)} + + +By means of \verb+philex+ commands, the brackets can be \marginpar{Top-level brackets} removed or replaced for all the top-level environments except \verb+\lb+ itself. However, as of version 4.0 of \verb+linguex+, the brackets for the \verb+\lb+ command can be customized. By means of + +\begin{verbatim} +\renewcommand{\ExLBr}{]} +\renewcommand{\ExRBr}{[} +\renewcommand{\FnExLBr}{\{} +\renewcommand{\FnExRBr}{\}} +\end{verbatim} + you can change the \verb+\lb+ brackets to square brackets in main text and to curly brackets in footnotes. + + +For the other cases, you might e.g. want an \verb+\lbp+ environment without label. To turn the brackets off, give the command \verb+\broff+ before the environment. To turn them back on later, give the command \verb+\bron+. + +The non-\verb+\lb+ top-level brackets can be reset by the two-argument command \verb+\philbrackets+. For instance \verb+\philbrackets{[}{]}+ will make the following environment labels have square brackets. + +There is sometimes a reason \marginpar{Punctuation} to embed the content of an environment in running text or in another environment, so that changes in the original environment are automatically reflected (see below on cross-references). You might then not want the original full stop of an environment sentence to come along. For this purpose there is a punctuation command \verb+\philpunct+ at the end of top-level environments. By default, \verb+\philpunct+ is set to be empty. You can redefine it to provide a full stop by means of \verb+\philfullstop+ before the environment. The command \verb+\philcomma+ redefines it to produce a comma, \verb+\philexclaim+ produces an exclamation mark, \verb+\philquestion+ a question mark, and \verb+\philempty+ turns it back to empty. By means of \verb+\renewcommand{\philpunct}{}+ you can set it as you like. + +In earlier versions of \verb+philex+ the corresponding commands were \verb+\p+, \verb+\s+ (for full stop), \verb+\km+ (for comma) and \verb+\q+ (empty). Mostly because I have learned that it is bad design to use one-letter commands, these are now replaced by the new commands. In case of typesetting a file with the old commands, choose the package option \verb+<oldpunct>+. + +\verb+linguex+ has \marginpar{Footnotes} sensitivity to footnote contexts, and provides a separate counter, \verb+FnExNo+, that is reset in each footnote. This is inherited by \verb+philex+.\note + {The result is illustrated by + \lb{ffnote}{A first footnote example:} + \lb{sfnote}{A second footnote example.} + which shows that numbering is lowercase roman.} + +\section{Sub-environments} +\verb+linguex+ and \marginpar{\tt \(\backslash\)lba, \(\backslash\)lbb, and \(\backslash\)lbz} hence also \verb+philex+ provides sub-environments (sublists) . To illustrate, the code + +\begin{verbatim} +\lbp{clauses}{PP}{Some main words, followed by +\lba{first}{Time flies +\lba{firstnew}{Like an arrow} +\lbz{lastnew}{And much too fast}} +\lbb{second}{But never stops} +\lbz{last}{Which is lucky} +and a concluding comment.} +\end{verbatim} +produces + +\lbp{clauses}{PP}{Some main words, followed by +\lba{first}{Time flies} +\lba{firstnew}{Like an arrow} +\lbz{lastnew}{And much too fast} +\lbb{second}{But never stops} +\lbz{last}{Which is lucky} +and a concluding comment.} + As shown in the source example, the sub-environments must be embedded in the last argument of the top-level command. A second-level sub-environment need not be embedded in the first-level sub-environment (and so on). + +As exemplified, sub-environments can be nested up to three levels. The first two levels have their own counters, \verb+SubExNo+ and \verb+SubSubExNo+, provided by \verb+linguex+. + +The \verb+\lba+ command restarts the counter of the relevant level. The \verb+\lbb+ command steps the counter, while the \verb+\lbz+ command steps the counter and closes the level, returning to the next higher level. It is not necessary to use \verb+\lbz+ for the last item at the first sub-level (i.e. at the end of a top-level environment). In case only a single sub-environment is used, the command \verb+\z.+ of \verb+linguex+ returns to the higher level. + +The labels of the first two sub-levels can be \marginpar{Label formatting} customized in two ways, with respect to numbering style and with respect to brackets. The command \verb+\subformat+ takes three arguments. + +The first argument determines the numbering style. The value \qut{R} displays the counter in upper-case roman numerals, \qut{r} in lower case roman, \qut{1} in arabic numerals, \qut{A} in upper-case alphabetic listing, and \qut{a} in lower-case alphabetic listing. Default for the first sub-level is lower-case alphabetic. + +The second argument sets the prefix (opening bracket) and the third argument sets the suffix (closing bracket). Default for the first sub-level is no left-hand bracket and a period for the suffix, as shown in the example. + +The corresponding command for the second sub-level is \verb+\subsubformat+, with the same arguments and values. Default for the second sub-level is lower-case roman numerals for displaying the counter, and ordinary left- and right-hand round brackets, as shown in the example (these defaults are set by \verb+linguex+). To exemplify, the source code + +\begin{verbatim} +\lbu{clausesup}{clauses}{$'$}{ +\subformat{A}{}{)} +\subsubformat{1}{[}{]} +Some introductory words, followed by +\lba{firstb}{Time flies} +\lba{firstnewb}{Like an arrow} +\lbz{lastnewb}{And much too fast} +\lbb{secondb}{But never stops} +\lbz{lastb}{Which is lucky} +and a concluding comment.} +\end{verbatim} + +produces + +\lbu{clausesup}{clauses}{$'$}{ +\subformat{A}{}{)} +\subsubformat{1}{[}{]} +Some introductory words, followed by +\lba{firstb}{Time flies} +\lba{firstnewb}{Like an arrow} +\lbz{lastnewb}{And much too fast} +\lbb{secondb}{But never stops} +\lbz{lastb}{Which is lucky} +and a concluding comment.} + +If the sub-formatting commands are given within the top-level environment, they control only the labels within that environment. If they are given outside, the commands are valid until superseded by later commands. + +The sub-level commands \marginpar{Names for \\ sub-environments} have an optional argument (inherited from \verb+linguex+) that can be used for naming sub-environments. For instance, the source + +\begin{verbatim} +\lb{crane}{The saying +\lba[S]{squeak}{The squeaky wheel gets the grease} +\z. +is often confirmed.} +\end{verbatim} + produces + + +\lb{crane}{The saying +\lba[S]{squeak}{The squeaky wheel gets the grease} +\z. +is often confirmed.} + Round brackets are put in by default. This can be reset by the \verb+\philbrackets+ command. + +Punctuation for sub-environments \marginpar{Punctuation for \\ sub-environments} is controlled by means of the commands \verb+\philsubpunct+, \verb+\philsubstop+, \verb+\philsubcomma+, \verb+\philsubexclaim+, \verb+\philsubquestion+, and \verb+\philsubempty+, analogous to the corresponding top-level commands. The corresponding older commands where \verb+\pt+, \verb+\stp+ (full stop), \verb+\kmt+ (comma), and \verb+\qt+ (empty). As before, they are made active by means of the \verb+<oldpunct>+ package option. + +\section{Cross-references} +The first argument of all environment commands are used by \verb+philex+ to give a \verb+\label+ command. If the environment is numbered by a counter, the label makes the environment accessible for cross-reference by the standard cross-reference mechanism of LaTeX. For instance, \verb+\ref{nice}+ produces the cross-reference `\ref{nice}' to the first \verb+\lb+ environment on page \pageref{nice}.\note + {The reason for the fuss about brackets is that in order to modify the material within the brackets, e.g. with {\tt lbu}, the brackets cannot be hard-coded into the cross-reference command, but must be put in afterwords.} + +However, \verb+philex+ provides \marginpar{\tt \(\backslash\)rf, \(\backslash\)rn} its own cross-reference command, \verb+\rf+, which has a wider function. It provides ordinary cross-references in accordance with the numbering style of the antecedent, and keeps track of the embedding. It also provides cross-references to \emp{named} environments, where there is no counter value to pick up. The difference between \verb+\rf+ and \verb+\rn+ is that the latter leaves out the brackets. So we will have the productions +\begin{trivlist} +\item \noindent \verb+\rf{nice}+ \(\longrightarrow\) \rf{nice} \hfill (target on page \pageref{nice}) +\item \noindent \verb+\rf{kne}+ \(\longrightarrow\) \rf{kne} \hfill (target on page \pageref{kne}) +\item \noindent \verb+\rn{kne}+ \(\longrightarrow\) \rn{kne} \hfill (target on page \pageref{kne}) +\item \verb+\rn{clauseup}+ \(\longrightarrow\) \rn{clausesup} \hfill (target on page \pageref{clausesup}) +\item \verb+\rf{lastnew}+ \(\longrightarrow\) \rf{lastnew}\hfill (target on page \pageref{lastnew}) +\item \verb+\rf{lastnewb}+ \(\longrightarrow\) \rf{lastnewb} \hfill (target on page \pageref{lastnewb}) +\end{trivlist} + Both \verb+\rf+ and \verb+\rn+ have an optional argument which produces an optional suffix. \verb+\rf[*]{nice}+ produces \rf[*]{nice}. + +Both \verb+linguex+ and \verb+philex+ \marginpar{Inner delimiters} provide customizing of inner delimiters in complex cross-references. \verb+linguex+ has changed in version 4.0 (see its manual). With \verb+philex+, use the \verb+\phildashes{}{}+ \marginpar{\tt \(\backslash\)phildashes} command. This works together with the \verb+\subformat+ and the \verb+\subsubformat+ commands. The first argument sets the delimiter between the top-level reference and the reference to the first sub-environment, while the second argument sets the delimiter between references to the first and the second sub-level environments. To illustrate. We use the input +\begin{verbatim} +\lb{cool}{We would like a colon +\phildashes{:}{} +\subformat{a}{}{)} +\lba{coola}{before reference to this.} +\lba{coolb}{but nothing more before reference to this}} +\end{verbatim} +to create and make a cross-reference with \verb+\rf{coolb}+ to \rf{coolb} below: +\lb{cool}{We would like a colon +\phildashes{:}{} +\subformat{a}{}{)} +\lba{coola}{before reference to this} +\lba{coolb}{but nothing more before reference to this.}} + +If the \verb+hyperref+ package \marginpar{\tt hyperref} is called (must be called last) in the preamble, all ordinary cross-references of the label+cross-reference mechanism of LaTeX are by default made into pdf hyperlinks. This includes all cross-references in \verb+philex+ that rely on counters. If the \verb+<hyper>+ package option is also called, cross-references to \emp{named} environments are made into hyperlinks as well. + +This is useful for reading pdf:s on the screen, and also for \verb+beamer+ slide-show presentations: click on a cross-reference to a named principle, and you are taken to the page where that principle is stated. In \verb+beamer+ you are taken to the first slide of the relevant frame. + +Sub-environments can \marginpar{Cross-reference to \\ sub-environments in footnotes} be used in footnotes as well. But here, to get the cross-references right, the \verb+subformat+ command must be used.\note + {This is illustrated by + \lb{ffnote}{A first footnote example: + \subformat{a}{}{)} + \lba{fnota}{Be careful in footnotes.}} + \lb{sfnote}{A second footnote example.} + This cross-reference to \rf{fnota} is correct.} + The example is produced by the input +\begin{verbatim} +\lb{ffnote}{A first footnote example: + \subformat{a}{}{)} + \lba{fnota}{Be careful in footnotes.}} + \lb{sfnote}{A second footnote example. + This cross-reference to \rf{fnota} is correct.} +\end{verbatim} + +\verb+philex+ also has cross-reference \marginpar{Repeating content} functions for repeating the \emp{contents} of environment. By means of \verb+\rp{nicy}+ you repeat the content of \rf{nicy}: \rp{nicy} If you want to embed the content in another sentence, you may want the initial capital letter to be made lowercase. Then use the \verb+\ml+ command, as in + +\lb{jsays}{John says that \ml{nice}} + produced by +\begin{verbatim} +\lb{jsays}{John says that \ml{nice}} +\end{verbatim} + +In case you want a full stop at the end of an earlier environment and want to embed the content without the stop, you can use the \verb+\philfullstop+ command to have it inserted for you: + + + + +\begin{verbatim} +\philfullstop +\lb{stop}{It is very cold} +\philexclaim +\lb{ifstop}{If \ml{stop}, you should put on a cap} +\end{verbatim} + produces + +\philfullstop +\lb{stop}{It is very cold} +\philexclaim + +\lb{ifstop}{If \ml{stop}, you should put on a cap} +\philempty + +Finally, one can repeat an entire environment with label by means of the \verb+\rff+ command. \verb+\rff{nice}+ produces \rff{nice} + +\section{Lengths and spaces} +\verb+linguex+ provides a number length and spacing commands that can be used to customize the appearance of \verb+philex+ environments. Below are given the length name, brief explanation, and the default value set by \verb+linguex+. \qut{hspace} is short for \qut{horizontal space} and \qut{vspace} analogously: + +\begin{trivlist} +\item \verb+\Exlabelsep+ (hspace after label) \hfill \verb+1.3em+ +\item \verb+\Extopsep+ (extra vspace above and below) \hfill \verb+.66\baselineskip+ +\item \verb+\SubExleftmargin+ (hspace after sub-level label) \hfill \verb+2em+ +\item \verb+\SubSubExleftmargin+ (hspace after sub-sub-level label) \hfill \verb+2.4em+ +\item \verb+\Exindent+ (indent of the environment) \hfill \verb+0pt+ +%\item \verb+\Exlabelwidth+ (width of top-level label) \hfill \verb+4em+ +\end{trivlist} + Beside these, \verb+philex+ modifies \verb+linguex+ by letting two re-definable commands replace hard-coded lengths: + +\begin{trivlist} +\item \verb+\phlabelwidth{}+ (width of label) \hfill \verb+3em+ +\item \verb+\phlabeldefault+ (returns to default value) +\item \verb+\phlabelsep{}+ (sets hspace after label to the argument, e.g. 1cm) +\item \verb+\phlabelsepdefault+ (sets default value of the label separation) +\item \verb+\Exredux+ (vspace reduction between environments) \hfill \verb+-\baselineskip+ +\end{trivlist} + +If one needs longer labels, e.g. as names of principles or for other purposes, one can use \verb+\phlabelwidth+ in combination with \verb+\Exlabelsep+. For example + +\begin{verbatim} +\setlength{\Exlabelsep}{2cm} +\phlabelwidth{4cm} +\broff +\lb{defe}{Compositionality:}{The meaning ... etc. } +\end{verbatim} + has the following effect: + + + +\setlength{\Exlabelsep}{2cm} +\phlabelwidth{4cm} +\broff + +\lbp{compo}{Compositionality:}{The meaning of a complex expression is a function of the meanings of its parts and its mode of composition.} + For two-column documents, the label separation should preferably be somewhat reduced. This has to be set manually by means of these commands, since there is no automatic adaptation to two-column options or environments. + +\setlength{\Exlabelsep}{1.3em} +\phlabeldefault + + +Vertical spacing is controlled with \verb+\Extopsep+ and \verb+\Exredux+. The second controls the reduction of inter-environment vertical space and needs to be adapted to the general control of vertical space. To illustrate, the input + +\begin{verbatim} +\setlength{\Extopsep}{2\baselineskip} +\setlength{\Exredux}{-3\baselineskip} +\end{verbatim} + has the following effect on vertical spacing: + +\setlength{\Extopsep}{2\baselineskip} +\setlength{\Exredux}{-3\baselineskip} + +\lb{vertia}{First vertical space example} +\lb{vertib}{Second vertical space example} +\lb{vertic}{Third vertical space example} + Next line comes here. + +\setlength{\Extopsep}{.66\baselineskip} +\setlength{\Exredux}{-1\baselineskip} + + +\section{Troubleshooting} +The most \marginpar{Infelicitous labels} common problem you can run into with \verb+philex+ derives from an infelicitous choice of label (first argument to the commands). \verb+philex+ creates new command names (control sequences) from the labels, and especially with short labels it sometimes happens that a generated label coincides with a control sequence defined by TeX, or LaTeX, or some document class or package. Typesetting will halt with an error message that does not give the appropriate information. The location of the error need not be right either. + +To remedy, try replacing your latest label(s) by new ones that are unlikely to clash with other control sequences. + +Another type or error \marginpar{\tt hyperref \normalfont and the\\ .aux file} can occur in case the \verb+hyperref+ package is used, and \verb+hyperref+ does not find the information it needs in the .aux file, perhaps because of an error in a previous round. + +The remedy is to enter non-stop typesetting mode by pressing \qut{r} in response to the error message. Typesetting will be completed, with incorrect results, but the next round of typesetting will then work as it should. If there is still a problem, abort typesetting, trash the auxiliary file and start over. + +A problem may arise \marginpar{math environment in \tt lbu} because LaTeX style math environment delimiters (\verb+\(..\)+) are used in the third argument (the update symbol) of the \verb+\lbu+ command. To avoid this problem, use TeX style delimiters (\verb+$..$+) instead. + +A further possible problem derives from \marginpar{Clash between \\ \texttt {hyperref} and \\ \texttt{linguex}} a clash between \verb+linguex+ and fairly recent versions of \verb+hyperref+. This (as has been explained to me by Heiko Oberdiek) depends on a conflict over the use of \verb+\b+. The result will be that sub-environments will lack labels and be incorrectly formatted. + +The remedy has been provided by Heiko Oberdiek, who has added a workaround in \verb+hyperref+. To make use of this, make sure that your version of \verb+hyperref+ is 6.78o (from 2009.02.02) or later. + +There is also \marginpar{Clash between \\ \texttt{setspace} and \\ \tt linguex} a conflict between the \verb+setspace+ package and \verb+linguex+. The problem seems to be that \verb+setspace+ redefines \verb+\@footnotetext+ in a way that interferes with the way \verb+linguex+ is meant to work in footnotes. + +To avoid this problem, load \verb+philex+ (and \verb+linguex+ too, if called) \emp{after} \verb+setspace+. Also, don't use the \verb+\setstretch+ command in the preamble for setting line spacing. Rather set a \verb+spacing+ environment in the main body, after \verb+\begin{document}+. This environment may span the entire main document. + +Finally, \marginpar{Comments} bug reports, comments or suggestions are welcome and should be directed to Peter Pagin at \hyperref{mailto:peter.pagin@philosophy.su.se}{}{}{peter.pagin@philosophy.su.se}. + + + + + +\end{document}
\ No newline at end of file |