New minor release 4.5.4

docs/conf.py

@@ -17,15 +17,15 @@
     'sphinx.ext.intersphinx',
 ]
 
-intersphinx_mapping = {'python': ('http://docs.python.org/3', None)}
+intersphinx_mapping = {'python': ('http://docs.python.org/3.3', None)}
 
 templates_path = ['_templates']
 source_suffix = '.rst'
 master_doc = 'index'
-project = 'LAF Fabric'
-copyright = '2013, Dirk Roorda'
+project = u'LAF Fabric'
+copyright = u'2013, Dirk Roorda'
 version = '4.5'
-release = '4.5.3'
+release = '4.5.4'
 exclude_patterns = ['_build']
 add_function_parentheses = True
 add_module_names = False
@@ -39,7 +39,7 @@
     html_theme = 'default'
 else:
     html_theme = 'sphinx_rtd_theme'
-html_theme_path = ['_themes', ]
+html_theme_path = ["_themes", ]
 
 html_static_path = ['_static']
 html_domain_indices = True
@@ -58,32 +58,32 @@
 }
 
 latex_documents = [
-  ('index', 'LAF_Fabric.tex', 'LAF Fabric Documentation',
-   'Dirk Roorda', 'manual'),
+  ('index', 'LAF_Fabric.tex', u'LAF Fabric Documentation',
+   u'Dirk Roorda', 'manual'),
 ]
 
 # -- Options for manual page output ---------------------------------------
 
 man_pages = [
-    ('index', 'LAF_Fabric', 'LAF Fabric Documentation',
-     ['Dirk Roorda'], 1)
+    ('index', 'LAF_Fabric', u'LAF Fabric Documentation',
+     [u'Dirk Roorda'], 1)
 ]
 
 # -- Options for Texinfo output -------------------------------------------
 
 texinfo_documents = [
-  ('index', 'LAF_Fabric', 'LAF Fabric Documentation',
-   'Dirk Roorda', 'LAF Fabric', 'One line description of project_name.',
+  ('index', 'LAF_Fabric', u'LAF Fabric Documentation',
+   u'Dirk Roorda', 'LAF Fabric', 'One line description of project_name.',
    'Miscellaneous'),
 ]
 
 # -- Options for Epub output ----------------------------------------------
 
-epub_title = 'LAF Fabric'
-epub_author = 'Dirk Roorda'
-epub_publisher = 'Dirk Roorda'
-epub_copyright = '2013, Dirk Roorda'
-epub_basename = 'LAF_Fabric'
+epub_title = u'LAF Fabric'
+epub_author = u'Dirk Roorda'
+epub_publisher = u'Dirk Roorda'
+epub_copyright = u'2013, Dirk Roorda'
+epub_basename = u'LAF_Fabric'
 epub_theme = 'epub'
 epub_show_urls = 'footnote'
 epub_use_index = True

docs/conf.py.bck

@@ -17,15 +17,15 @@ extensions = [
     'sphinx.ext.intersphinx',
 ]
 
-intersphinx_mapping = {'python': ('http://docs.python.org/3.3', None)}
+intersphinx_mapping = {'python': ('http://docs.python.org/3', None)}
 
 templates_path = ['_templates']
 source_suffix = '.rst'
 master_doc = 'index'
-project = u'LAF Fabric'
-copyright = u'2013, Dirk Roorda'
+project = 'LAF Fabric'
+copyright = '2013, Dirk Roorda'
 version = '4.5'
-release = '4.5.2'
+release = '4.5.3'
 exclude_patterns = ['_build']
 add_function_parentheses = True
 add_module_names = False
@@ -39,7 +39,7 @@ if on_rtd:
     html_theme = 'default'
 else:
     html_theme = 'sphinx_rtd_theme'
-html_theme_path = ["_themes", ]
+html_theme_path = ['_themes', ]
 
 html_static_path = ['_static']
 html_domain_indices = True
@@ -58,32 +58,32 @@ latex_elements = {
 }
 
 latex_documents = [
-  ('index', 'LAF_Fabric.tex', u'LAF Fabric Documentation',
-   u'Dirk Roorda', 'manual'),
+  ('index', 'LAF_Fabric.tex', 'LAF Fabric Documentation',
+   'Dirk Roorda', 'manual'),
 ]
 
 # -- Options for manual page output ---------------------------------------
 
 man_pages = [
-    ('index', 'LAF_Fabric', u'LAF Fabric Documentation',
-     [u'Dirk Roorda'], 1)
+    ('index', 'LAF_Fabric', 'LAF Fabric Documentation',
+     ['Dirk Roorda'], 1)
 ]
 
 # -- Options for Texinfo output -------------------------------------------
 
 texinfo_documents = [
-  ('index', 'LAF_Fabric', u'LAF Fabric Documentation',
-   u'Dirk Roorda', 'LAF Fabric', 'One line description of project_name.',
+  ('index', 'LAF_Fabric', 'LAF Fabric Documentation',
+   'Dirk Roorda', 'LAF Fabric', 'One line description of project_name.',
    'Miscellaneous'),
 ]
 
 # -- Options for Epub output ----------------------------------------------
 
-epub_title = u'LAF Fabric'
-epub_author = u'Dirk Roorda'
-epub_publisher = u'Dirk Roorda'
-epub_copyright = u'2013, Dirk Roorda'
-epub_basename = u'LAF_Fabric'
+epub_title = 'LAF Fabric'
+epub_author = 'Dirk Roorda'
+epub_publisher = 'Dirk Roorda'
+epub_copyright = '2013, Dirk Roorda'
+epub_basename = 'LAF_Fabric'
 epub_theme = 'epub'
 epub_show_urls = 'footnote'
 epub_use_index = True

docs/texts/ETCBC-reference.rst

@@ -152,6 +152,16 @@ There are some points to note:
   After applying the mapping ``hebrew()``, these characters will be *always* decomposed.
 * up till now we have only transcription conversions for *consonantal Hebrew*.
 
+.. note::
+    The ETCBC transcription is *easy* in the sense that it is 1-1 correspondence between the transcription and the Hebrew.
+    (There are one or two cases where the ETCBC transcription distinguishes between accents that are indistiguishable
+    in UNICODE.
+
+    A *phonetic* transcription is also available, but it has been computed at a later stage, and added as an
+    extra annotation package to the data.
+    This is a *difficult* transcription, since a lot of complicated rules govern the road from spelling to 
+    pronunciation, such as qamets gadol versus qatan, schwa mobile versus quiescens, to name but a few.
+
 Syriac
 ------
 We have a transcription for consonantal Syriac. The interface is nearly the same as for Hebrew, but now use::
@@ -241,11 +251,42 @@ You only need to write a function that delivers the data in the right form, and
 
 Usage::
 
+    import laf
+    from laf.fabric import LafFabric
     from etcbc.extra import ExtraData
+    fabric = LafFabric()
 
-More info:
-`notebook para from px <http://nbviewer.ipython.org/github/ETCBC/laf-fabric-nbs/blob/master/extradata/para%20from%20px.ipynb>`_
+    API=fabric.load(...) # load the data and features
+
+    xtra = ExtraData(API)
+
+    xtra.deliver_annots(annox, metadata, sets)
+
+where ``sets`` is a list of tuples::
+
+    (data_base, annox_part, read_method, specs)
+
+The result is a new annox, i.e. a set of annotations, next to the main data.
+Its name is given in the *annox* parameter.
+Its metadata consists of a dicionary, containing a key ``title`` and a key ``data``.
+Its actual annotations are divided in sets, which will be generated from various data sources.
+Each *set* is specified by the following information:
+
+* ``data_base`` is a relative path within the LAF data directory to a file containing the raw data for a set of annotations;
+* ``annox_part`` is a name for this set;
+* ``read_method`` is a function, taking a file path as argument. It then reads that file, and delivers a list of data items,
+  where each data item is a tuple consisting of a node and additional values.
+  The node is the target node for the values, which will be values of features to be specified in the *specs*.
+  This method will be called with the file specified in the *data_base* argument;
+* ``specs`` is a series of tuples, each naming a new feature in the new annotation set.
+  The tuple consists of the *namespace*, *label*, and *name* of the new feature.
+  The number of feature specs must be equal to the number of additional values in the data list that is delivered by *read_method*.
+
+When *deliver_annots* is done, the new annox can be used straight away.
+Note that upon first use, the XML of this annox has to be parsed and compiled into binary data, which might take a while.
 
+To see this method in action, have a look at the
+`lexicon notebook <https://shebanq.ancient-data.org/shebanq/static/docs/tools/shebanq/lexicon.html>`_.
 
 Feature documentation
 =====================