Skip to content
This repository has been archived by the owner on Nov 24, 2021. It is now read-only.

Commit

Permalink
New minor release 4.5.18
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkroorda committed Mar 2, 2016
1 parent c937d9a commit d85fbbe
Show file tree
Hide file tree
Showing 19 changed files with 97 additions and 2,069 deletions.
3 changes: 0 additions & 3 deletions MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ emdros2laf/laf.py
emdros2laf/mylib.py
emdros2laf/run.py
emdros2laf/settings.py
emdros2laf/settings_conflict-20160221-210653.py
emdros2laf/transform.py
emdros2laf/validate.py
emdros2laf/templates/annotation_decl.xml
Expand Down Expand Up @@ -60,8 +59,6 @@ laf/fabric.py
laf/lib.py
laf/model.py
laf/names.py
laf/names_conflict-20160218-110922.py
laf/parse.py
laf/settings.py
laf/settings_conflict-20160221-210653.py
laf/timestamp.py
Binary file removed dist/laf-fabric-4.5.12.tar.gz
Binary file not shown.
Binary file added dist/laf-fabric-4.5.18.tar.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
project = u'LAF Fabric'
copyright = u'2013, Dirk Roorda'
version = '4.5'
release = '4.5.12'
release = '4.5.18'
exclude_patterns = ['_build']
add_function_parentheses = True
add_module_names = False
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py.bck
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ master_doc = 'index'
project = u'LAF Fabric'
copyright = u'2013, Dirk Roorda'
version = '4.5'
release = '4.5.12'
release = '4.5.17'
exclude_patterns = ['_build']
add_function_parentheses = True
add_module_names = False
Expand Down
89 changes: 0 additions & 89 deletions docs/conf.py_conflict-20160218-170310.bck

This file was deleted.

89 changes: 0 additions & 89 deletions docs/conf_conflict-20160221-210726.py

This file was deleted.

72 changes: 64 additions & 8 deletions docs/texts/ETCBC-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,39 +98,59 @@ and say in your load instructions::

'prepare': prepare
Then you can use the following functions::
Then you can use the following functions

.. code-block:: python
T.node_of(book, chapter, verse)
Yields the verse node of the passage specified by `book`, `chapter` and `verse`.
Yields `None` if there is no such verse.::
Yields `None` if there is no such verse.

Book must be given as a *node*, the book name for the verse_label will be in language `lang`.
See the methods `book_name()` and `book_node()` below to map a book name to a book node and vice versa.

.. code-block:: python
T.formats()
This yields a dictionary of all formats that the ``T`` API is capable to deliver.
The keys are acronymns for the formats, the values are tuples
``(desc, method)``
where ``desc`` is a short description of the format, and ``method`` is a Python function that delivers that representation given a single word node.:
where ``desc`` is a short description of the format, and ``method`` is a Python function that delivers that representation given a single word node.

.. code-block:: python
T.words(word_nodes, fmt='ha')
Give the plain text belonging to a series of words in format ``fmt``.
Default format is ``ha``, i.e. fully pointed Hebrew Unicode, where ketivs have been replaced by
fully pointed qeres.
The ``word_nodes`` can be any iterable of nodes carrying ``otype = 'word'``.
They do not have to correspond to consecutive words in the bible.:
They do not have to correspond to consecutive words in the bible.

.. code-block:: python
T.verse(book, chapter, verse, fmt='ha', html=True, verse_label=True, format_label=True)
T.verse(book, chapter, verse, fmt='ha', html=True, verse_label=True, format_label=True, lang='en')
Give the plain text of the indicated verse in format ``fmt``.
You can choose wether to include a verse label (like ``Genesis 3:7``) and a format label
(like ``hebrew accent``).

If ``html`` is ``True`` then the result is formatted as a html table, with the right style characteristics.
You can still tweak the styles a bit, see the function ``T.style()`` later on.:
You can still tweak the styles a bit, see the function ``T.style()`` later on.

T.whole(fmt='ha', verse_labels=False)
Like in `node_of()`, `book` must be given as a node.
See the methods `book_name()` and `book_node()` below to map a book name to a book node and vice versa.

Give the plain text of the whole Bible in format ``fmt``.:
.. code-block:: python
T.whole(fmt='ha', verse_labels=False, lang='en')
Give the plain text of the whole Bible in format ``fmt``.
The language for the book names in the verse labels is given by `lang`.

.. code-block:: python
T.style(params=None, show_params=False)
Expand All @@ -144,6 +164,42 @@ You can also set the widths of the label columns.

You only have to pass the parameters that you want to give a non-default value.

.. code-block:: python
T.book_name(book_node, lang='en')
Returns the book name of the book corresponding to `book_node` in language `lang`.

.. code-block:: python
T.book_node(book_name, lang='en')
Returns the book node of the book with name `book_name` in language `lang`.

If `lang` is `la` (latin), the book names are exactly as used in the ETCBC database.

Supported languages:

* en = English (default)
* nl = Dutch
* de = German
* fr = French
* el = Greek
* he = Hebrew (modern)
* la = Latin (used in the ETCBC database).

For the list of all languages, call

.. code-block:: python
T.langs
.. code-block:: python
T.book_nodes
For convenience, the tuple of nodes corresponding to the books in the ETCBC order.

.. _node_order:

Node order
Expand Down

0 comments on commit d85fbbe

Please sign in to comment.