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

A bit of structure for the api docs bazaar.

This commit is contained in:
Miguel de Benito 2012-09-21 20:43:48 +00:00
parent f937fefbc0
commit 5fe5725f1d
3 changed files with 62 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
devel/scheme/api/api.en.tm Normal file
View File

@ -0,0 +1,30 @@
<TeXmacs|1.0.7.15>
<style|tmdoc>
<\body>
<tmdoc-title|About the API documentation>
Documentation for <TeXmacs> internal features and API is typically written
as part of the general documentation, where it's most natural for someone
reading the manual as a book. However it often happens that some <scheme>
module or procedure needs documenting but doesn't fit into any of the
available sections of the manual. The purpose of this section is precisely
to assemble all those pieces of information. Currently (sept. 2012) there
are very sketchy pages for:
<\traverse>
<branch|<tt|tmfs>: the <TeXmacs> file system.|tmfs/tmfs.en.tm>
<branch|The linking system.|link.en.tm>
</traverse>
<tmdoc-copyright|2012|the <TeXmacs> team>
<tmdoc-license|Permission is granted to copy, distribute and/or modify
this\ndocument under the terms of the GNU Free Documentation License,
Version 1.1 or\nany later version published by the Free Software
Foundation; with no Invariant\nSections, with no Front-Cover Texts, and
with no Back-Cover Texts. A copy of\nthe license is included in the section
entitled "GNU Free Documentation License".>
</body>

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

@ -20,7 +20,7 @@
(if possible or necessary), setting the window title and establishing (if possible or necessary), setting the window title and establishing
access permissions are the basic operations. Predefined handlers which the access permissions are the basic operations. Predefined handlers which the
user usually encounters are <tt|grep>, <tt|help>, <tt|history>, user usually encounters are <tt|grep>, <tt|help>, <tt|history>,
<tt|revision> and <tt|sapi>: they accept a query representing search <tt|revision> and <tt|apidoc>: they accept a query representing search
strings, files or help pages and render results in the appropriate language strings, files or help pages and render results in the appropriate language
into a new buffer. The <em|query> is a string in the usual format into a new buffer. The <em|query> is a string in the usual format
<tt|variable1=value1&variable2=value2>. Its parsing can be done using <tt|variable1=value1&variable2=value2>. Its parsing can be done using
@ -29,10 +29,10 @@
Situations where using this system makes more sense than regular documents Situations where using this system makes more sense than regular documents
are for instance documentation, which must be chosen from several languages are for instance documentation, which must be chosen from several languages
and possibly be compiled on the fly from various sources (see module and possibly be compiled on the fly from various sources (see module
<tt|<hlink|doc.sapi|tmfs://sapi/type=module&what=doc.sapi>>) and <tt|<hlink|doc.apidoc|tmfs://apidoc/type=module&what=doc.apidoc>> and
automatically generated content, like that resulting from interacting from related modules) and automatically generated content, like that resulting
an external system for version control of documents (see handler from interacting from an external system for version control of documents
<tt|version> in module <tt|<hlink|version.version-tmfs|tmfs://sapi/type=module&what=version.version-tmfs>>). (see handler <tt|version> in module <tt|<hlink|version.version-tmfs|tmfs://apidoc/type=module&what=version.version-tmfs>>).
<subsection|Implementing a handler> <subsection|Implementing a handler>
@ -183,7 +183,8 @@
<\explain> <\explain>
<scm|(tmfs-master-handler (<scm-arg|name> <scm-arg|qry> <scm-arg|doc>) <scm|(tmfs-master-handler (<scm-arg|name> <scm-arg|qry> <scm-arg|doc>)
<scm-arg|body>)><explain-synopsis|define title handler @name> <scm-arg|body>)><explain-synopsis|define title handler @name>
</explain|A <em|master handler> is...> </explain|A <em|master handler> is... (possibly related to the concept of
master document in a project, but this needs checking)>
<\explain> <\explain>
<scm|(query-ref <scm-arg|qry> <scm-arg|arg>)><explain-synopsis|return <scm|(query-ref <scm-arg|qry> <scm-arg|arg>)><explain-synopsis|return
@ -217,13 +218,5 @@
<scm|tmfs-permission-handler> and <scm|tmfs-title-handler>. <scm|tmfs-permission-handler> and <scm|tmfs-title-handler>.
</explain> </explain>
<subsection|More advanced usage>
The <TeXmacs> file system is actually a much more complicated beast, with
versioning, network access and authentication built in among other things.
This documentation should be completed with all those features.
\;
<tmdoc-copyright|2012|the <TeXmacs> team.> <tmdoc-copyright|2012|the <TeXmacs> team.>
</body> </body>

25
devel/scheme/api/tmfs/tmfs.en.tm Normal file
View File

@ -0,0 +1,25 @@
<TeXmacs|1.0.7.15>
<style|tmdoc>
<\body>
<tmdoc-title|The <TeXmacs> file system>
The <TeXmacs> file system is a complicated beast, with versioning, network
access and authentication built in among other things. This documentation
should be completed with all those features, but in the meantime, we have
the following:
<\traverse>
<branch|A <tt|tmfs> primer.|tmfs-basics.en.tm>
</traverse>
<tmdoc-copyright|2012|the <TeXmacs> team.>
<tmdoc-license|Permission is granted to copy, distribute and/or modify
this\ndocument under the terms of the GNU Free Documentation License,
Version 1.1 or\nany later version published by the Free Software
Foundation; with no Invariant\nSections, with no Front-Cover Texts, and
with no Back-Cover Texts. A copy of\nthe license is included in the section
entitled "GNU Free Documentation License".>
</body>