diff --git a/devel/scheme/api/api.en.tm b/devel/scheme/api/api.en.tm new file mode 100644 index 0000000..28ed813 --- /dev/null +++ b/devel/scheme/api/api.en.tm @@ -0,0 +1,30 @@ + + + + +<\body> + + + Documentation for 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 + 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> + : the file system.|tmfs/tmfs.en.tm> + + + + + team> + + + \ No newline at end of file diff --git a/devel/scheme/api/tmfs/tmfs-basics.en.tm b/devel/scheme/api/tmfs/tmfs-basics.en.tm index 2200cc6..338fd13 100644 --- a/devel/scheme/api/tmfs/tmfs-basics.en.tm +++ b/devel/scheme/api/tmfs/tmfs-basics.en.tm @@ -20,7 +20,7 @@ (if possible or necessary), setting the window title and establishing access permissions are the basic operations. Predefined handlers which the user usually encounters are , , , - and : they accept a query representing search + and : they accept a query representing search strings, files or help pages and render results in the appropriate language into a new buffer. The is a string in the usual format . Its parsing can be done using @@ -29,10 +29,10 @@ Situations where using this system makes more sense than regular documents are for instance documentation, which must be chosen from several languages and possibly be compiled on the fly from various sources (see module - >) and - automatically generated content, like that resulting from interacting from - an external system for version control of documents (see handler - in module >). + > and + related modules) and automatically generated content, like that resulting + from interacting from an external system for version control of documents + (see handler in module >). @@ -183,7 +183,8 @@ <\explain> ) )> - is...> + is... (possibly related to the concept of + master document in a project, but this needs checking)> <\explain> )> and . - - - The 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. - - \; - team.> \ No newline at end of file diff --git a/devel/scheme/api/tmfs/tmfs.en.tm b/devel/scheme/api/tmfs/tmfs.en.tm new file mode 100644 index 0000000..bd97753 --- /dev/null +++ b/devel/scheme/api/tmfs/tmfs.en.tm @@ -0,0 +1,25 @@ + + + + +<\body> + file system> + + The 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> + primer.|tmfs-basics.en.tm> + + + team.> + + + \ No newline at end of file