]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Additional.lyx
More XHTML documentation.
[lyx.git] / lib / doc / Additional.lyx
index 696fba15b76e5ea4058a15e69e99c15d72cf81bb..bdf93219721aed6b1effc102ffc5f460c378d93c 100644 (file)
@@ -4379,7 +4379,7 @@ Another advantege is that, since these routines are internal to LyX, they
 \begin_inset Quotes eld
 \end_inset
 
-Chaper 1
+Chapter 1
 \begin_inset Quotes erd
 \end_inset
 
@@ -4473,6 +4473,214 @@ begriff.sty
  or images, and it will offer this choice on a case by case basis.
 \end_layout
 
+\begin_layout Standard
+The remainder of this chapter contains more detailed information on XHTML
+ output, its limitations, and ways around those limitations.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+This is very incomplete at this point!
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Section
+Bibliography and Citations
+\end_layout
+
+\begin_layout Standard
+XHTML output fully supports bibliographies and citations.
+\end_layout
+
+\begin_layout Standard
+Citation labels are generated by exactly the same machinery that generates
+ LyX's on-screen labels, so the labels will look in the output much as they
+ do in LyX, though better.
+ If you are using numerical citations, then LyX will output numerical labels,
+ such as [1] or [17], rather than simply showing the citation key in square
+ brackets, as it does on-screen.
+ If you are using author-year citations, then LyX will add lowercase letters
+ to the years, just as BibTeX does, if it finds more than one citation for
+ a given author-year combination.
+ The labels will be printed with the bibliography entries.
+ Note that there is, at present, no way to customize the appearance of the
+ labels, for example, to choose between square brackets and parentheses.
+\end_layout
+
+\begin_layout Standard
+Bibliography output is handled by the same machinery that handles the presentati
+on of reference information in the citation dialog, so you will see in the
+ XHTML output pretty much what you would see if you were to look at a given
+ entry in the citation dialog.
+ Unfortunately, the formatting of bibliography entries, too, is at present
+ not customizable, and it is fairly primitive, though this should change
+ shortly.
+\end_layout
+
+\begin_layout Standard
+The other significant defect is that cross-referenced information is printed
+ with every entry with which it is associated.
+ So you can see things like this:
+\end_layout
+
+\begin_layout Quote
+Jason Stanley, 
+\begin_inset Quotes eld
+\end_inset
+
+Context and Logical Form
+\begin_inset Quotes erd
+\end_inset
+
+, in 
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 30--68.
+\end_layout
+
+\begin_layout Quote
+Jason Stanley, 
+\begin_inset Quotes eld
+\end_inset
+
+Semantics in Context
+\begin_inset Quotes erd
+\end_inset
+
+, in 
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 201--30.
+\end_layout
+
+\begin_layout Standard
+Again, this should be fixed before long.
+\end_layout
+
+\begin_layout Standard
+There is no support at present for sectioned bibliographies.
+ If you have multiple bibliographies, then LyX will print the same bibliography
+ over and over.
+\end_layout
+
+\begin_layout Section
+Indexes
+\end_layout
+
+\begin_layout Standard
+LyX will happily export indexes as XHTML, but with certain limitations at
+ the moment.
+\end_layout
+
+\begin_layout Standard
+Index export will be most reliable when you do not attempt to use the fancy
+ constructs that are described in the section on indexes in the 
+\emph on
+User's Guide
+\emph default
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The main issue here is that LyX itself does not really handle these.
+ It just lets you enter what you would have to enter in raw LaTeX.
+\end_layout
+
+\end_inset
+
+ We'll describe how they are handled using the subsection headings from
+ that section.
+\end_layout
+
+\begin_layout Itemize
+Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
+ these, but the entries must be separated by 
+\begin_inset Quotes eld
+\end_inset
+
+ ! 
+\begin_inset Quotes erd
+\end_inset
+
+, that is, there must be spaces around the exclamation point.
+ This is because it is otherwise too difficult to check for escaped exclamation
+ points, ones in math, and so forth.
+\end_layout
+
+\begin_layout Itemize
+Page Ranges: There is no support at all for page ranges, since these make
+ no sense with XHMTL.
+ Instead, you will just get two index entries, one at either end.
+\end_layout
+
+\begin_layout Itemize
+Cross-referencing: There is no support for cross-referencing.
+ If LyX finds an entry containing the 
+\begin_inset Quotes eld
+\end_inset
+
+|see\SpecialChar \ldots{}
+
+\begin_inset Quotes erd
+\end_inset
+
+ construct, it is just dropped, and the rest is treated as an ordinary index
+ entry.
+\end_layout
+
+\begin_layout Itemize
+Index Entry Order: LyX does support attempts to fix the sorting order.
+ It will take what is before the first `@' it finds and use that for sorting,
+ taking what follows the first `@' to be the actual entry.
+ At present, LyX does not check for escaped `@', so do not try to index
+ email addresses.
+\end_layout
+
+\begin_layout Itemize
+Index Entry Layout: You can format entries by using the text style dialog,
+ or by using any other method available within LyX itself.
+ There is no support for constructs like: 
+\begin_inset Quotes eld
+\end_inset
+
+entry|textbf
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
+ and everything that follows it.
+\end_layout
+
+\begin_layout Itemize
+Multiple Indexes: There is no support for multiple indexes.
+ Rather, all index entries will be printed as one large index.
+ To avoid our printing several versions of the index, we print only the
+ main index, so make sure you have one.
+\end_layout
+
+\begin_layout Section
+Nomenclature and Glossary
+\end_layout
+
+\begin_layout Standard
+There is at present no support for glossaries.
+\end_layout
+
 \begin_layout Chapter
 The LyX Server
 \end_layout
@@ -18827,7 +19035,7 @@ Ditto.
 
  
 \family typewriter
-svn update 
+svn update --non-interactive 
 \begin_inset Quotes eld
 \end_inset
 
@@ -19568,16 +19776,10 @@ puttygen
  In case the SVN server runs on linux, note that the format of the public
  key is not compatible with linux openssh and you will need to direcly copy-past
 e the key from the “
-\begin_inset Flex CharStyle:Emph
-status collapsed
-
-\begin_layout Plain Layout
-Public key for pasting into OpenSSH authorized_keys file:
-\end_layout
-
-\end_inset
-
-” edit field into the server's 
+\emph on
+Public key for pasting into OpenSSH authorized_keys file
+\emph default
+:” edit field into the server's 
 \begin_inset Flex CharStyle:Code
 status collapsed