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

Complete documentation of basic buffer API

This commit is contained in:
Joris van der Hoeven 2012-04-23 13:31:19 +00:00
parent bacaf0910d
commit 42259dd3b1
3 changed files with 41 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
about/changes/change-log.en.tm
View File

@ -8,8 +8,13 @@
<section|Changes from version 1.0.7 to 1.0.7.16> <section|Changes from version 1.0.7 to 1.0.7.16>
<\itemize> <\itemize>
<item>Reorganized buffer management and documentation of the new API
(1.0.7.16).
<item>Rudimentary support for version control using SVN (1.0.7.16). <item>Rudimentary support for version control using SVN (1.0.7.16).
<item>Rudimentary support for graphical macros without text (1.0.7.16).
<item>First rudimentary spreadsheet facility (1.0.7.15). <item>First rudimentary spreadsheet facility (1.0.7.15).
<item>Special editing mode for writing <TeXmacs> documentation <item>Special editing mode for writing <TeXmacs> documentation

3
devel/scheme/buffer/buffer-api.en.tm
View File

@ -79,6 +79,9 @@
<|explain> <|explain>
Set the contents of the buffer <scm-arg|buf> to the rich tree Set the contents of the buffer <scm-arg|buf> to the rich tree
<scm-arg|rich-t>, <abbr|resp.> get the rich contents of <scm-arg|buf>. <scm-arg|rich-t>, <abbr|resp.> get the rich contents of <scm-arg|buf>.
Rich trees do not only contain the actual body of the document, but also
some meta-data, such as its style, initial values of environment
variables, and other auxiliary data attached to the document.
</explain> </explain>
<\explain> <\explain>

34
devel/scheme/buffer/buffer-intro.en.tm
View File

@ -5,7 +5,39 @@
<\body> <\body>
<tmdoc-title|Introduction> <tmdoc-title|Introduction>
\; There are three main kinds of objects for buffer management in <TeXmacs>:
<\description>
<item*|Buffers>Every open <TeXmacs> document is stored in a unique
editable buffer. Buffers typically admit a<nbsp>one to one correspondence
to files on disk or elsewhere on the web. Some buffers are of a<nbsp>more
auxiliary nature, such as automatically generated help buffers. All
buffers admit a unique URL. In the case of auxiliary buffers, this URL is
really a read-only ``placeholder'', so saving this kind of buffers is
impossible (of course, it remains possible to save the buffer under a new
name).
<item*|Views>It is possible to have multiple views on the same buffer.
Every view is identified by a<nbsp>unique automatically generated URL,
which again acts as a placeholder.
<item*|Windows>Views (contrary to the buffers themselves) can be
displayed in actual windows. Currently, any <TeXmacs> window contains a
unique view and a view may only be displayed in one window at the same
time (of course, it is possible to display different views on the same
buffer in different windows). Windows are again represented by
automatically generated<nbsp>URLS.
</description>
<\remark>
In the future, views and windows should really be considered as documents
themselves. Changes in the view will be automatically propagated (or not)
to the corresponding buffer, and the other views. Windows will contain a
document which specifies its layout (menus and toolbars). The
corresponding view (or views) will be an active hyperlink (or active
hyperlinks). The current APIs already reflect these future development
intentions.
</remark>
<tmdoc-copyright|2012|Joris van der Hoeven> <tmdoc-copyright|2012|Joris van der Hoeven>