]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
docs: port fix and update description of labeling
[lyx.git] / lib / doc / UserGuide.lyx
index 9471ec986c3e311c87c414cbf6f5b44c5542b772..2157442b06dd344c3d3a97188f0e31fba20a2152 100644 (file)
@@ -134,7 +134,7 @@ enumitem
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
-\author 424524441 "rgheck
+\author 5863208 "ab
 \author 2090807402 "usti" 
 \end_header
 
@@ -1492,7 +1492,11 @@ arg   "bookmark-goto 0"
 \family sans
 Navigate\SpecialChar \menuseparator
 Bookmarks\SpecialChar \menuseparator
-NavigateBack
+Navigate
+\begin_inset space ~
+\end_inset
+
+Back
 \family default
 ) jumps to the position in the document where you recently changed something.
  This is useful when you have a large document and have navigated or scrolled
@@ -1500,8 +1504,23 @@ NavigateBack
  your last editing position.
 \end_layout
 
+\begin_layout Standard
+By pressing the 
+\family sans
+F5
+\family default
+ key the cursor will be vertically centered in LyX's main window.
+\end_layout
+
 \begin_layout Subsection
 The Outliner
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:The-Outliner"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -1536,12 +1555,10 @@ reference "sec:Bibliography"
 \end_layout
 
 \begin_layout Standard
-Right-clicking on elements in the Outline will in many cases open a context
+Right-clicking on elements in the Outline opens in many cases a context
  menu that will allow for direct modification of those elements.
  For example, with citations, the context menu allows you to open the citation
  dialog and to modify the citation.
- Right-clicking a change will allow you to accept or reject it.
- And so on.
 \end_layout
 
 \begin_layout Standard
@@ -1619,7 +1636,7 @@ depth
 
 \begin_layout Standard
 The 
-\begin_inset space ~
+\begin_inset space \space{}
 \end_inset
 
 
@@ -5903,16 +5920,12 @@ Notice that after the first line, LyX indents subsequent lines, offsetting
 \end_layout
 
 \begin_layout Subsubsection
-The LyX 
-\family sans
-List
-\family default
-
+Labeling
 \begin_inset Index idx
 status collapsed
 
 \begin_layout Plain Layout
-Lists ! LyX list
+Lists ! Labeling
 \end_layout
 
 \end_inset
@@ -5923,35 +5936,9 @@ Lists ! LyX list
 \begin_layout Standard
 The 
 \family sans
-List
-\family default
- environment is a LyX extension to LaTeX.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Greyedout
-status collapsed
-
-\begin_layout Plain Layout
-
-\series bold
-Note:
-\series default
- When you are using a KOMA-Script document class, like in this document,
- the 
-\family sans
-List
-\family default
- environment is named 
-\family sans
 Labeling
 \family default
-.
-\end_layout
-
-\end_inset
-
-
+ environment is a LyX extension to LaTeX.
 \end_layout
 
 \begin_layout Standard
@@ -5959,12 +5946,13 @@ Like the
 \family sans
 Description
 \family default
environment the 
list the 
 \family sans
-List
+Labeling
 \family default
- environment has user-defined labels for each list item.
- There are the following properties of this list environment:
+ list has user-defined labels for each list item but it provides some additional
+ features.
+ Here are its properties:
 \end_layout
 
 \begin_layout Labeling
@@ -6030,7 +6018,7 @@ default
 width You can set the default label width to ensure that the text of all
  items in a 
 \family sans
-List
+Labeling
 \family default
  environment has the same left margin.
 \begin_inset Newline newline
@@ -6046,7 +6034,13 @@ Paragraph
 
 Settings
 \family default
- dialog.
+ dialog (toolbar button 
+\begin_inset Info
+type  "icon"
+arg   "layout-paragraph"
+\end_inset
+
+).
  The text in the box 
 \family sans
 Longest
@@ -6104,34 +6098,14 @@ The predefined default width is the length of
 \end_inset
 
 M).
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Note Greyedout
-status collapsed
-
-\begin_layout Plain Layout
-
-\series bold
-Note:
-\series default
- Setting the cursor into a list item to change only its label width will
- only change the width inside LyX but not in the output.
-\end_layout
-
-\end_inset
-
-
 \end_layout
 
 \begin_layout Standard
 You should use the 
 \family sans
-List
+Labeling
 \family default
environment the same way as the 
list the same way as the 
 \family sans
 Description
 \family default
@@ -6139,7 +6113,7 @@ Description
  it.
  The 
 \family sans
-List
+Labeling
 \family default
  environment gives you another way to do this, using a different overall
  layout.
@@ -6148,10 +6122,9 @@ List
 \begin_layout Standard
 You can nest 
 \family sans
-List
+Labeling
 \family default
- environments inside one another, nest them in other types of lists, and
- so on.
+ lists inside one another, nest them in other types of lists, and so on.
  They work just like the other list paragraph environments.
  Read section
 \begin_inset space ~
@@ -6170,10 +6143,10 @@ reference "sec:Nesting"
 \begin_layout Standard
 There is yet another feature of the 
 \family sans
-List
+Labeling
 \family default
- environment: As you can see in the examples, LyX left-justifies the item
labels by default.
+ list: As you can see in the examples, LyX left-justifies the item labels
+ by default.
  You can use additional 
 \family sans
 HFills
@@ -6202,7 +6175,7 @@ reference "sub:Horizontal-Space"
 \labelwidthstring 00.00.0000
 Left The default for 
 \family sans
-List
+Labeling
 \family default
  item labels.
 \end_layout
@@ -11136,6 +11109,16 @@ Protect
 
 \begin_layout Subsection
 Paragraph Alignment
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+Paragraph ! Alignment
+\end_layout
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -11144,7 +11127,13 @@ You can change the paragraph alignment with the
 Edit\SpecialChar \menuseparator
 Paragraph Settings
 \family default
- dialog.
+ dialog (toolbar button 
+\begin_inset Info
+type  "icon"
+arg   "layout-paragraph"
+\end_inset
+
+).
  There are five possibilities: 
 \end_layout
 
@@ -14451,9 +14440,9 @@ device-independent
 \begin_layout Standard
 DVI files do not contain images, they only link to them.
  So don't forget to deliver the images together with your DVIs.
- Because the DVI-viewer has to convert the image in the background to make
- it visible when you scroll the DVI, this can slow down your computer when
- you view the DVI.
+ Because the DVI-viewer has to convert the images in the background to make
+ them visible when you scroll the DVI, this can slow down your computer
when you view the DVI.
  So we recommend using PDF for files with many images.
 \end_layout
 
@@ -15006,9 +14995,9 @@ This file type has the extension
 
 .
  It is a file suitable for viewing in web browsers.
- It does not itself contain images and the like but only links to them,
- and when LyX produces XHTML, it also generates corresponding images in
formats suitable for the purpose.
+ It does not itself contain images and the like but only links to them.
+ When LyX produces XHTML, it also generates corresponding images in formats
+ suitable for the purpose.
  For the math output you can choose in the menu 
 \family sans
 Document\SpecialChar \menuseparator
@@ -15086,7 +15075,7 @@ View
 \family sans
 View
 \family default
- or the toolbar button 
+ or use the toolbar button 
 \begin_inset Info
 type  "icon"
 arg   "buffer-view"
@@ -15204,7 +15193,7 @@ You can choose to print only even-numbered or odd-numbered pages — this
 \end_layout
 
 \begin_layout Standard
-You can set the parameters in the 
+You can set the following print parameters in the 
 \family sans
 Print
 \begin_inset space ~
@@ -15212,7 +15201,7 @@ Print
 
 Destination
 \family default
- box as follows:
+ box:
 \end_layout
 
 \begin_layout Labeling
@@ -17456,7 +17445,7 @@ Graphics Dialog
 
 \begin_layout Standard
 The graphics dialog can be called at any time by clicking on an image.
- The image will appear in the output exactly at the position where it is
+ Images will appear in the output exactly at the position where they are
  in the text.
  This is an example image within a separate, horizontally centered paragraph:
  
@@ -18198,10 +18187,16 @@ The Table dialog
 \end_layout
 
 \begin_layout Standard
-You can alter a table by clicking on it with the right mouse button, which
- brings up the table dialog.
- Here you can adjust the settings of the cell and row/column respectively
- where the cursor is placed currently.
+You can alter a table by clicking on it with the right mouse button and
+ then choosing 
+\family sans
+More\SpecialChar \menuseparator
+Settings
+\family default
+.
+ This brings up the table dialog.
+ Here you can adjust the settings of the cell, row and/or column where the
+ cursor is placed currently.
  Most of the dialog options also work on selections.
  This means that if you select more cells, columns or rows the action is
  done on all of your selection.
@@ -18217,7 +18212,7 @@ table
 toolbar
 \family default
  helps you in setting table properties.
- It appears when the cursor is inside a table.
+ It appears if the cursor is inside a table.
 \end_layout
 
 \begin_layout Standard
@@ -18267,7 +18262,7 @@ one
  cell, spread over more than one column/row.
  Multicolumn cells are treated as own rows, so that the alignment, width,
  and border settings affect only the multicolumn cell.
- Here's an example table with a multicolumn cell in the first row and one
+ Here is an example table with a multicolumn cell in the first row and one
  in the last row without the upper border:
 \end_layout
 
 \begin_layout Standard
 Adept users can declare special LaTeX-arguments for the table.
  They are necessary for special table formatting, like for multirow cells,
- explained in the tables section of the 
+ explained in the chapter 
+\emph on
+Tables
+\emph default
+ of the 
 \emph on
 Embedded
 \begin_inset space ~
@@ -18593,8 +18592,8 @@ Objects
 \begin_layout Standard
 You can also specify a row where the table is split.
  If you set more than one option in the same table row, you should be aware
- that only the first one is used in the given table row.
- The others will then be defined as 
+ that then only the first option is used; the others will be defined as
 \emph on
 empty
 \emph default
@@ -18617,10 +18616,9 @@ First
 \begin_inset space ~
 \end_inset
 
-header.
-
+header
 \family default
- See the following longtable to see how it works:
+; see the following longtable to see how it works:
 \end_layout
 
 \begin_layout Standard
@@ -20808,8 +20806,7 @@ A table cell can contain text, inline equations, a figure, or another table.
 \family sans
 Section*
 \family default
-, etc.), nor set spacing options etc.
- for the cell's paragraph.
+, etc.), nor set spacing options for the cell's paragraph.
 \end_layout
 
 \begin_layout Standard
@@ -21133,15 +21130,15 @@ Margin
 Notes
 \family default
  are also floats, because they can float to the next page when there are
- too many notes on the page.
+ too many notes on the current page.
 \end_layout
 
 \begin_layout Standard
 Floats make it possible to get a high quality layout.
- Images and tables can be spread evenly over the pages to avoid whitespace
+ Images and tables can be distributed evenly over the pages to avoid whitespace
  and pages without text.
- As the floating often destroys the context between the text and the image/table
-, every float can be referenced in the text.
+ As the floating often destroys the spatial context between the text and
+ the image/table, every float can be referenced in the text.
  Floats are therefore numbered.
  Referencing is described in section
 \begin_inset space ~
@@ -21873,7 +21870,7 @@ name "sec:Minipages"
 LaTeX provides a mechanism to produce essentially a page within a page,
  called minipage.
  Within a minipage, all the usual rules of indentation, line wrapping, etc.
-\begin_inset space ~
+\begin_inset space \space{}
 \end_inset
 
 apply.
@@ -21887,7 +21884,7 @@ Insert\SpecialChar \menuseparator
 Box
 \family default
 .
- Right-clicking on the box allows you to alter the width of the minipage
+ Right-clicking on the box label allows you to alter the width of the minipage
  and its alignment within the page.
 \end_layout
 
@@ -21904,7 +21901,7 @@ width "30col%"
 special "none"
 height "1pt"
 height_special "totalheight"
-status collapsed
+status open
 
 \begin_layout Plain Layout
 
@@ -21963,7 +21960,7 @@ width "1.5in"
 special "none"
 height "1pt"
 height_special "totalheight"
-status collapsed
+status open
 
 \begin_layout Plain Layout
 This is a minipage with some stupid dummy text.
@@ -21988,7 +21985,7 @@ width "1.5in"
 special "none"
 height "1pt"
 height_special "totalheight"
-status collapsed
+status open
 
 \begin_layout Plain Layout
 This is a minipage with some stupid dummy text.
@@ -22008,8 +22005,8 @@ This is a minipage with some stupid dummy text.
 \end_layout
 
 \begin_layout Standard
-When you right-click on a minipage box, you can change the box from a minipage
to other box types.
+When you right-click on a minipage box, you can transform the box to another
box type.
  All box types and their settings are explained in detail in chapter 
 \emph on
 Boxes
@@ -22131,7 +22128,7 @@ math
 
 toolbar
 \family default
-, that appears when the cursor is in a formula.
+, that appears if the cursor is in a formula.
 \end_layout
 
 \begin_layout Standard
@@ -26044,7 +26041,7 @@ Outline
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Navigating"
+reference "sub:The-Outliner"
 
 \end_inset
 
@@ -27879,8 +27876,8 @@ Index of Names
 \end_inset
 
  next to the standard index.
- LaTeX does not provide this possibility out of the box, but there are many
packages that add this feature.
+ LaTeX does not provide this possibility out of the box, but there are packages
+ that add this feature.
  LyX uses the 
 \series bold
 splitidx
@@ -27897,7 +27894,11 @@ LaTeX-packages ! splitidx
 
  package to generate multiple indexes.
  The package is included in all recent LaTeX distributions.
- If yours does not ship it, consult the TeX-catalogue, 
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+If yours does not ship it, consult the TeX-catalogue, 
 \begin_inset CommandInset citation
 LatexCommand cite
 key "TeXCatalogue"
@@ -27910,6 +27911,11 @@ key "TeXCatalogue"
  Please consult the package's manual for details.
 \end_layout
 
+\end_inset
+
+
+\end_layout
+
 \begin_layout Standard
 To set up LyX for the use of multiple indexes, go to 
 \family sans
@@ -27917,56 +27923,37 @@ Document\SpecialChar \menuseparator
 Settings\SpecialChar \menuseparator
 Indexes
 \family default
- and select 
-\begin_inset Quotes eld
-\end_inset
-
+ and select the option 
+\family sans
 Use multiple Indexes
-\begin_inset Quotes erd
-\end_inset
-
+\family default
 .
- Note that the list of 
+ Note that the list 
+\family sans
+Available Indexes
+\family default
+ already contains the standard index 
 \begin_inset Quotes eld
 \end_inset
 
-Available Indexes
+Index
 \begin_inset Quotes erd
 \end_inset
 
- below already contains the standard index.
+.
  To add further indexes, add the name of the index (in the form that should
  also appear as a heading) to the 
-\begin_inset Quotes eld
-\end_inset
-
+\family sans
 New
-\begin_inset Quotes erd
-\end_inset
-
+\family default
  input field and press the 
-\begin_inset Quotes eld
-\end_inset
-
+\family sans
 Add
-\begin_inset Quotes erd
-\end_inset
-
- button.
- The new index should now appear in the list as well.
- If you like, you can attribute an alternative label color to the new index
- by selecting the index in the list and hitting the 
-\begin_inset Quotes eld
-\end_inset
-
-Alter Color\SpecialChar \ldots{}
-
-\begin_inset Quotes erd
-\end_inset
-
+\family default
  button.
- The label color may help you to differentiate between index entries of
- different indexes in the LyX work area.
+ The new index now also appears in the list.
+ If you like, you can attribute an alternative LyX label color to the new
+ index.
 \end_layout
 
 \begin_layout Standard
@@ -27988,19 +27975,19 @@ TOC
 \family sans
 Insert
 \family default
- menu has a separate index entry for each of the defined indexes.
+ menu has a separate entry for each of the defined indexes.
  The workflow is basically the same as for the default index, but there
- are some additional features:
+ are additional features:
 \end_layout
 
 \begin_layout Itemize
 If you want to change the attribution of a specific index entry, right-clicking
- on the entry will open a dialog where you can do that.
+ on the entries' label will open a dialog where you can do that.
 \end_layout
 
 \begin_layout Itemize
 By right-clicking on an index, you can change its type.
- Furthermore, you can specify an index list to be a 
+ Furthermore, you can specify an index to be a 
 \begin_inset Quotes eld
 \end_inset
 
@@ -29269,6 +29256,28 @@ Inside math, the same effect can be achieved using math macros, see the
 Math
 \emph default
  manual.
+\change_inserted 5863208 1334492666
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 5863208 1334493356
+Each type of branch is allowed to have its specific style defined in layout
+ files (e.g.
+ any branch inset can be automatically wrapped by your own LaTeX commands.).
+ For this advanced usage, please study Customization manual (in particular
+ section 
+\begin_inset Quotes eld
+\end_inset
+
+Flex insets and InsetLayout
+\begin_inset Quotes erd
+\end_inset
+
+).
+\change_unchanged
+
 \end_layout
 
 \begin_layout Section
@@ -32153,28 +32162,50 @@ arg   "thesaurus-entry"
  A dialog pops up showing you probably related words that you can use as
  a replacement.
  The proposals are grouped into categories.
- Note that the thesaurus does not only show synonyms, but also hyperonyms
- and hyponyms (such as 
+ Note that, for some languages (such as English), the thesaurus does not
+ only show equivalent words (synonyms), but also generic terms (such as
+\emph on
+organism
+\emph default
+ for 
 \emph on
 plant
+\emph default
+), related terms (such as 
+\emph on
+political
+\begin_inset space ~
+\end_inset
+
+theory
 \emph default
  for 
 \emph on
-tree
+anarchistic
 \emph default
 ), compounds (such as 
 \emph on
-tree diagram
+tree
+\begin_inset space ~
+\end_inset
+
+diagram
+\emph default
+, if you look for 
+\emph on
+tree
 \emph default
-) and antonyms (such as 
+) and opposites (antonyms) (such as 
 \emph on
-women
+girl
 \emph default
  for 
 \emph on
-men
+boy
 \emph default
-), which are marked as such.
+).
+ Generic terms, related terms and antonyms are marked as such.
 \end_layout
 
 \begin_layout Standard
@@ -32194,13 +32225,20 @@ tree diagram
 \end_inset
 
 e.
- the form that is used in the dictionaries (for many languages: first person
+\begin_inset space \space{}
+\end_inset
+
+the form that is used in the dictionaries (for many languages: first person
  singular indicative active for nouns, infinitive for verbs).
- For example looking up the word forms 
+ For example looking up the word form
+\change_deleted 2090807402 1338765333
+s 
 \emph on
 reports
 \emph default
- or 
+ or
+\change_unchanged
 \emph on
 reporting
 \emph default
@@ -32209,12 +32247,30 @@ reporting
 report
 \emph default
 .
+\change_inserted 2090807402 1338765282
+The thesuarus is able to resolve inflected forms (so if you enter 
+\emph on
+reports
+\emph default
+, it will resolve it to the form 
+\emph on
+report
+\emph default
+ which is in the dictionary).
+ However, this may not always work.
+ So if you do not get any results for inflected forms, try the lemma form.
+
+\change_unchanged
  Your best bet is to highlight only the relevant parts of such word (e.
 \begin_inset space \thinspace{}
 \end_inset
 
 g.
+\begin_inset space \space{}
+\end_inset
+
+
 \emph on
 report
 \emph default
@@ -43431,12 +43487,6 @@ Text Layout
 You can specify if paragraphs should be separated by indentations or vertical
  skips.
  The line spacing and the number of text columns can also be specified here.
-
-\change_inserted 2090807402 1325640630
- You can also determine whether text will be shown as justified in LyX itself.
- Note that this does not affect whether the text is justified in the output.
-\change_unchanged
-
 \end_layout
 
 \begin_layout Standard
@@ -48606,7 +48656,7 @@ The LyX Team:
 \begin_inset CommandInset href
 LatexCommand href
 name "Credits"
-target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/CREDITS"
+target "http://www.lyx.org/Credits"
 
 \end_inset
 
@@ -48620,7 +48670,7 @@ status collapsed
 
 \begin_layout Plain Layout
 
-http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/CREDITS
+http://www.lyx.org/Credits
 \end_layout
 
 \end_inset