texmacs
/
doc
mirror of https://github.com/texmacs/doc.git
1
0
Fork 0
Code

Fixed some typos in docs

This commit is contained in:
Miguel de Benito 2013-07-10 20:26:30 +00:00
parent 849ec0d618
commit 17e823cd77
3 changed files with 75 additions and 129 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
devel/scheme/api/tmfs/tmfs-basics.en.tm
View File

@ -1,4 +1,4 @@
<TeXmacs|1.0.7.15> <TeXmacs|1.0.7.19>
<style|tmdoc> <style|tmdoc>
@ -45,7 +45,7 @@
procedures, one to handle the requests, another to create the document. procedures, one to handle the requests, another to create the document.
<\session|scheme|default> <\session|scheme|default>
<\unfolded-io|Scheme] > <\folded-io|Scheme] >
(tm-define (simple-load header body) (tm-define (simple-load header body)
\ \ `(document \ \ `(document
@ -55,13 +55,9 @@
\ \ \ \ \ (style (tuple "generic")) \ \ \ \ \ (style (tuple "generic"))
\ \ \ \ \ (body (document (section ,header) ,body)))) \ \ \ \ \ (body (document (section ,header) ,body))))
<|unfolded-io> <|folded-io>
((guile-user))
</unfolded-io>
<\input|Scheme] >
\; \;
</input> </folded-io>
</session> </session>
As you can see, we don't do much other than creating a <TeXmacs> document. As you can see, we don't do much other than creating a <TeXmacs> document.
@ -70,7 +66,7 @@
possible buffers. possible buffers.
<\session|scheme|default> <\session|scheme|default>
<\unfolded-io|Scheme] > <\folded-io|Scheme] >
(tmfs-load-handler (simple qry) (tmfs-load-handler (simple qry)
\ \ (let ((type (query-ref qry "type")) \ \ (let ((type (query-ref qry "type"))
@ -88,9 +84,9 @@
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ (string-append "Query \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ (string-append "Query
unknown: " what))))))) unknown: " what)))))))
<|unfolded-io> <|folded-io>
#\<less\>procedure #f (qry)\<gtr\> \;
</unfolded-io> </folded-io>
</session> </session>
We can test this right away with: We can test this right away with:
@ -111,22 +107,22 @@
and the window's title using a <em|title handler>: and the window's title using a <em|title handler>:
<\session|scheme|default> <\session|scheme|default>
<\unfolded-io|Scheme] > <\folded-io|Scheme] >
(tmfs-permission-handler (simple name type)\ (tmfs-permission-handler (simple name type)\
\ \ (display* "Name= " name "\\nType= " type "\\n") \ \ (display* "Name= " name "\\nType= " type "\\n")
\ \ #t) \ \ #t)
<|unfolded-io> <|folded-io>
#\<less\>procedure #f (name type)\<gtr\> \;
</unfolded-io> </folded-io>
<\unfolded-io|Scheme] > <\folded-io|Scheme] >
(tmfs-title-handler (simple qry doc) "Simple handler - Some title (tmfs-title-handler (simple qry doc) "Simple handler - Some title
here") here")
<|unfolded-io> <|folded-io>
#\<less\>procedure #f (qry doc)\<gtr\> \;
</unfolded-io> </folded-io>
</session> </session>
<\explain> <\explain>
@ -219,4 +215,7 @@
</explain> </explain>
<tmdoc-copyright|2012|the <TeXmacs> team.> <tmdoc-copyright|2012|the <TeXmacs> team.>
</body> </body>
<initial|<\collection>
</collection>>

157
devel/source/boxes.en.tm
View File

@ -1,18 +1,18 @@
<TeXmacs|1.0.1.11> <TeXmacs|1.0.7.19>
<style|tmdoc> <style|tmdoc>
<\body> <\body>
<expand|tmdoc-title|The boxes produced by the typesetter> <tmdoc-title|The boxes produced by the typesetter>
<section|Introduction> <section|Introduction>
The <apply|TeXmacs> typesetter essentially translates a document The <TeXmacs> typesetter essentially translates a document represented by a
represented by a tree into a graphical box, which can either be displayed tree into a graphical box, which can either be displayed on the screen or
on the screen or on a printer. Contrary to a system like <apply|LaTeX>, the on a printer. Contrary to a system like <LaTeX>, the graphical box actually
graphical box actually contains much more information than is necessary for contains much more information than is necessary for a graphical rendering.
a graphical rendering. Roughly speaking, this information can be subdivided Roughly speaking, this information can be subdivided into the following
into the following categories: categories:
<\itemize> <\itemize>
<item>Logical and physical bounding boxes. <item>Logical and physical bounding boxes.
@ -21,7 +21,7 @@
<item>Miscellaneous typesetting information. <item>Miscellaneous typesetting information.
<item>Keeping track of the source subtree which led to box. <item>Keeping track of the source subtree which led to the box.
<item>Computing the positions of cursors and selections. <item>Computing the positions of cursors and selections.
@ -81,28 +81,27 @@
More precisely, we have to deal with three kinds of paths: More precisely, we have to deal with three kinds of paths:
<\description> <\description>
<expand|item*|Tree paths.>These paths correspond to paths in the source <item*|Tree paths>These paths correspond to paths in the source tree.
tree. Actually, the path minus its last item points to a subtree of the Actually, the path minus its last item points to a subtree of the source
source tree. The last item gives a position in this subtree: if the tree. The last item gives a position in this subtree: if the subtree is a
subtree is a leaf, i.e. a string, it is a position in this string. leaf, i.e. a string, it is a position in this string. Otherwise a zero
Otherwise a zero indicates a position before the subtree and a one a indicates a position before the subtree and a one a position after the
position after the subtree. subtree.
<expand|item*|Inverse paths.>These are just reverted tree paths (with <item*|Inverse paths>These are just reverted tree paths (with shared
shared tails), with an optional negative head. A negative head indicates tails), with an optional negative head. A negative head indicates that
that the tree path is not accessible, i.e. the corresponding subtree does the tree path is not accessible, i.e. the corresponding subtree does not
not correspond to editable content. If the negative value is correspond to editable content. If the negative value is <math|-2>,
<with|mode|math|-2>, <with|mode|math|-3> or <with|mode|math|-4>, then a <math|-3> or <math|-4>, then a zero or one has to be put behind the tree
zero or one has to be put behind the tree path, depending on the value path, depending on the value and the cursor position.
and the cursor position.
<expand|item*|Box paths.>These paths correspond to logical paths in the <item*|Box paths>These paths correspond to logical paths in the box tree.
box tree. Again, the path minus its last item points to a subbox of the Again, the path minus its last item points to a subbox of the main box,
main box, and the last item gives a position in this subtree: if the and the last item gives a position in this subtree: if the subbox
subbox corresponds to a text box it is a position in this text. Otherwise corresponds to a text box it is a position in this text. Otherwise a zero
a zero indicates a position before the subbox and a one a position after indicates a position before the subbox and a one a position after it. In
it. In the case of side boxes, a two and a three may also indicate the the case of side boxes, a two and a three may also indicate the position
position after the left script resp. before the right script. after the left script resp. before the right script.
</description> </description>
<subsection|The conversion routines> <subsection|The conversion routines>
@ -138,21 +137,19 @@
<section|The cursor and selections> <section|The cursor and selections>
In order to fulfill the requirement of being a ``structured editor'', In order to fulfill the requirement of being a ``structured editor'',
<apply|TeXmacs> needs to provide a (reasonably) complete correspondence <TeXmacs> needs to provide a (reasonably) complete correspondence between
between logical tree paths and physical cursor positions. This yields an logical tree paths and physical cursor positions. This yields an additional
additional difficulty in the case of ``environment changes'', such as a difficulty in the case of ``environment changes'', such as a change in font
change in font or color. Indeed, when you are on the border of such a or color. Indeed, when you are on the border of such a change, it is not
change, it is not clear <with|font shape|italic|a priori> which environment clear <with|font-shape|italic|a priori> which environment you are in.
you are in.
In <apply|TeXmacs>, the cursor position therefore contains an In <TeXmacs>, the cursor position therefore contains an <math|x> and a
<with|mode|math|x> and a <with|mode|math|y> coordinate, as well as an <math|y> coordinate, as well as an additional infinitesimal
additional infinitesimal <with|mode|math|x>-coordinate, called <math|x>-coordinate, called <math|\<delta\>>. A change in environment is
<with|mode|math|\<delta\>>. A change in environment is then represented by then represented by a box with an infinitesimal width. Although the
a box with an infinitesimal width. Although the <math|\<delta\>>-position of the cursor is always zero when you select
<with|mode|math|\<delta\>>-position of the cursor is always zero when you using the mouse, it may be non zero when moving around using the cursor
select using the mouse, it may be non zero when moving around using the keys. The linear time routine:\
cursor keys. The linear time routine:\
<\verbatim> <\verbatim>
\ \ \ \ virtual path box_rep::find_box_path (SI x, SI y, SI delta) \ \ \ \ virtual path box_rep::find_box_path (SI x, SI y, SI delta)
@ -166,10 +163,10 @@
</verbatim> </verbatim>
yields a graphical representation for the cursor at a certain box path. The yields a graphical representation for the cursor at a certain box path. The
cursor is given by its <with|mode|math|x>, <with|mode|math|y> and cursor is given by its <math|x>, <math|y> and <math|\<delta\>> coordinates
<with|mode|math|\<delta\>> coordinates and a line segment relative to this and a line segment relative to this origin, given by its extremities
origin, given by its extremities <with|mode|math|(x<rsub|1>,y<rsub|1>)> and <math|<around|(|x<rsub|1>,y<rsub|1>|)>> and
<with|mode|math|(x<rsub|2>,y<rsub|2>)>. <math|<around|(|x<rsub|2>,y<rsub|2>|)>>.
In a similar way, the routine:\ In a similar way, the routine:\
@ -181,68 +178,18 @@
comprises two delimiting tree paths and a graphical representation in the comprises two delimiting tree paths and a graphical representation in the
form of a list of rectangles. form of a list of rectangles.
<apply|tmdoc-copyright|1998--2002|Joris van der Hoeven> <tmdoc-copyright|1998--2002|Joris van der Hoeven>
<expand|tmdoc-license|Permission is granted to copy, distribute and/or <tmdoc-license|Permission is granted to copy, distribute and/or modify this
modify this document under the terms of the GNU Free Documentation License, document under the terms of the GNU Free Documentation License, Version 1.1
Version 1.1 or any later version published by the Free Software Foundation; or any later version published by the Free Software Foundation; with no
with no Invariant Sections, with no Front-Cover Texts, and with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Back-Cover Texts. A copy of the license is included in the section entitled Texts. A copy of the license is included in the section entitled "GNU Free
"GNU Free Documentation License".> Documentation License".>
</body> </body>
<\initial> <\initial>
<\collection> <\collection>
<associate|paragraph width|150mm>
<associate|odd page margin|30mm>
<associate|shrinking factor|4>
<associate|page right margin|30mm>
<associate|page top margin|30mm>
<associate|reduction page right margin|25mm>
<associate|page type|a4>
<associate|reduction page bottom margin|15mm>
<associate|even page margin|30mm>
<associate|reduction page left margin|25mm>
<associate|page bottom margin|30mm>
<associate|reduction page top margin|15mm>
<associate|language|english> <associate|language|english>
</collection> </collection>
</initial> </initial>
<\references>
<\collection>
<associate|idx-1|<tuple|<uninit>|?>>
<associate|toc-1|<tuple|1|?>>
<associate|toc-2|<tuple|2|?>>
<associate|idx-2|<tuple|<uninit>|?>>
<associate|toc-3|<tuple|2.1|?>>
<associate|toc-4|<tuple|2.2|?>>
<associate|toc-5|<tuple|2.3|?>>
<associate|toc-6|<tuple|3|?>>
<associate|toc-7|<tuple|4.|?>>
</collection>
</references>
<\auxiliary>
<\collection>
<\associate|toc>
<vspace*|1fn><with|font series|<quote|bold>|math font
series|<quote|bold>|1<space|2spc>Introduction><value|toc-dots><pageref|toc-1><vspace|0.5fn>
<vspace*|1fn><with|font series|<quote|bold>|math font
series|<quote|bold>|2<space|2spc>The correspondence between a box and
its source><value|toc-dots><pageref|toc-2><vspace|0.5fn>
2.1<space|2spc>Discussion of the problems being
encountered<value|toc-dots><pageref|toc-3>
2.2<space|2spc>The three kinds of paths<value|toc-dots><pageref|toc-4>
2.3<space|2spc>The conversion routines<value|toc-dots><pageref|toc-5>
<vspace*|1fn><with|font series|<quote|bold>|math font
series|<quote|bold>|3<space|2spc>The cursor and
selections><value|toc-dots><pageref|toc-6><vspace|0.5fn>
</associate>
</collection>
</auxiliary>

6
main/scheme/man-menus.en.tm
View File

@ -1,4 +1,4 @@
<TeXmacs|1.0.7.14> <TeXmacs|1.0.7.19>
<style|tmdoc> <style|tmdoc>
@ -72,8 +72,8 @@
<scm|texmacs-main-icons>, <scm|texmacs-mode-icons>, <scm|texmacs-main-icons>, <scm|texmacs-mode-icons>,
<scm|texmacs-focus-icons> and <scm|texmacs-extra-icons>. Other standard <scm|texmacs-focus-icons> and <scm|texmacs-extra-icons>. Other standard
indirect menus are <scm|file-menu>, <scm|edit-menu>, <scm|insert-menu>, indirect menus are <scm|file-menu>, <scm|edit-menu>, <scm|insert-menu>,
<scm|text-menu>, <scm|paragraph-menu>, <scm|document-menu>, <scm|text-menu>, <scm|paragraph-menu>, <scm|document-menu> and
<scm|options-menu> and <scm|help-menu>. <scm|help-menu>.
<tmdoc-copyright|1998--2002|Joris van der Hoeven> <tmdoc-copyright|1998--2002|Joris van der Hoeven>