Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-07-09 03:04:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

add doc

Browse Source
This commit is contained in:
un-pogaz 2022-10-16 15:01:39 +02:00
parent 983bd742ab
commit e7cc30b3a9
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
manual/template_lang.rst
View File

@ -661,6 +661,7 @@ A PTM template begins with:
# db: a calibre legacy database object # db: a calibre legacy database object
# globals: the template global variable dictionary # globals: the template global variable dictionary
# arguments: is a list of arguments if the template is called by a GPM template, otherwise None # arguments: is a list of arguments if the template is called by a GPM template, otherwise None
# funcs: allows to use the Builtin/User functions and Stored GPM/Python templates
# your Python code goes here # your Python code goes here
return 'a string' return 'a string'
@ -669,6 +670,8 @@ You can add the above text to your template using the context menu, usually acce
The context object supports ``str(context)`` that returns a string of the context's contents, and ``context.attributes`` that returns a list of the attribute names in the context. The context object supports ``str(context)`` that returns a string of the context's contents, and ``context.attributes`` that returns a list of the attribute names in the context.
The ``context.funcs`` attribute allows to use the Builtin and User functions, and also the Stored GPM/Python templates so that you can exectute them directly in your code. The functions can be retrieve by they name and they name plus a '_' at the end in case of conflict with Python language keywords. Note that all functions will return a string value, only the special functions ``arguments()``, ``globals()`` and ``set_globals()`` will return a dict based on the passed keywords arguments.
Here is an example of a PTM template that produces a list of all the authors for a series. The list is stored in a `Column built from other columns, behaves like tags`. It shows in :guilabel:`Book details` and has the :guilabel:`on separate lines` checked (in :guilabel:`Preferences->Look & feel->Book details`). That option requires the list to be comma-separated. To satisfy that requirement the template converts commas in author names to semicolons then builds a comma-separated list of authors. The authors are then sorted, which is why the template uses author_sort. Here is an example of a PTM template that produces a list of all the authors for a series. The list is stored in a `Column built from other columns, behaves like tags`. It shows in :guilabel:`Book details` and has the :guilabel:`on separate lines` checked (in :guilabel:`Preferences->Look & feel->Book details`). That option requires the list to be comma-separated. To satisfy that requirement the template converts commas in author names to semicolons then builds a comma-separated list of authors. The authors are then sorted, which is why the template uses author_sort.
.. code-block:: python .. code-block:: python

1
src/calibre/gui2/dialogs/template_dialog.py
View File

@ -593,6 +593,7 @@ def evaluate(book, context):
# db: a calibre legacy database object # db: a calibre legacy database object
# globals: the template global variable dictionary # globals: the template global variable dictionary
# arguments: is a list of arguments if the template is called by a GPM template, otherwise None # arguments: is a list of arguments if the template is called by a GPM template, otherwise None
# funcs: allows to use the Builtin/User functions and Stored GPM/Python templates
# your Python code goes here # your Python code goes here
return 'a string' return 'a string'