summaryrefslogtreecommitdiff
path: root/next-lib/doc/synopsis-intro.txt
diff options
context:
space:
mode:
Diffstat (limited to 'next-lib/doc/synopsis-intro.txt')
-rw-r--r--next-lib/doc/synopsis-intro.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/next-lib/doc/synopsis-intro.txt b/next-lib/doc/synopsis-intro.txt
new file mode 100644
index 000000000..5a473d241
--- /dev/null
+++ b/next-lib/doc/synopsis-intro.txt
@@ -0,0 +1,26 @@
+
+
+
+=Introduction=
+
+This document contains the most important parts of the GF Resource Grammar API.
+It has been machine-generated from the source files; each chapter gives a link
+to the relevant source files, which give more information. Some of the files have
+not yet been prepared so that the machine generated documentation has the right
+format.
+
+Since the character encoding is UTF-8 for Russian and Latin-1 for other
+languages, you
+may have to change the encoding preference of your browser when reading different
+parts of the document.
+
+The second-last chapter gives instructions on how to "browse" the library by
+loading the grammars into the ``gf`` command editor.
+
+**New**: Browsing by syntax editor
+[directly on the web ../../../demos/resource-api/editor.html].
+
+The last chapter contains a brief example of how application grammars can
+import resource modules. At the same time, it illustrates a "design pattern" for
+using the resource API to build functor-based applications
+