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

Start using :ref: links.

Browse Source 
Note: I will look at generating HTML links once I see what the anchors look like in the new generated template_ref document. Today they look like
https://manual.calibre-ebook.com/generated/en/template_ref.html#add-x-y
I'm hoping that in the new system they will look something like
https://manual.calibre-ebook.com/generated/en/template_ref.html#ff_add
adding the ff_ and removing the parameters.
This commit is contained in:
Charles Haley 2024-11-12 12:07:31 +00:00
parent 38587e0b0a
commit da9332a535
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/calibre/utils/formatter_functions.py
View File

@ -701,7 +701,7 @@ r'''
``lookup(value, [ pattern, key, ]* else_key)`` -- The patterns will be checked against ``lookup(value, [ pattern, key, ]* else_key)`` -- The patterns will be checked against
the value in order. If a pattern matches then the value of the field named by the value in order. If a pattern matches then the value of the field named by
``key`` is returned. If no pattern matches then the value of the field named by ``key`` is returned. If no pattern matches then the value of the field named by
``else_key`` is returned. See also the ``switch()`` function. ``else_key`` is returned. See also the :ref:`switch` function.
''') ''')
def evaluate(self, formatter, kwargs, mi, locals, val, *args): def evaluate(self, formatter, kwargs, mi, locals, val, *args):
@ -986,7 +986,8 @@ r'''
``re_group(value, pattern [, template_for_group]*)`` -- return a string made by ``re_group(value, pattern [, template_for_group]*)`` -- return a string made by
applying the regular expression pattern to ``value`` and replacing each matched applying the regular expression pattern to ``value`` and replacing each matched
instance with the value returned by the corresponding template. In instance with the value returned by the corresponding template. In
`Template Program Mode`, like for the ``template`` and the [URL href="https://manual.calibre-ebook.com/template_lang.html#more-complex-programs-in-template-expressions-template-program-mode"]
Template Program Mode[/URL], like for the ``template`` and the
``eval`` functions, you use ``[[`` for ``{`` and ``]]`` for ``}``. ``eval`` functions, you use ``[[`` for ``{`` and ``]]`` for ``}``.
The following example looks for a series with more than one word and uppercases the first word: The following example looks for a series with more than one word and uppercases the first word:
@ -1210,8 +1211,8 @@ r'''
``formats_modtimes(date_format_string)`` -- return a comma-separated list of ``formats_modtimes(date_format_string)`` -- return a comma-separated list of
colon-separated items ``FMT:DATE`` representing modification times for the colon-separated items ``FMT:DATE`` representing modification times for the
formats of a book. The ``date_format_string`` parameter specifies how the date formats of a book. The ``date_format_string`` parameter specifies how the date
is to be formatted. See the ``format_date()`` function for details. You can use is to be formatted. See the :ref:`format_date` function for details. You can use
the ``select()`` function to get the modification time for a specific format. Note the :ref:`select` function to get the modification time for a specific format. Note
that format names are always uppercase, as in EPUB. that format names are always uppercase, as in EPUB.
''') ''')
@ -1293,10 +1294,11 @@ r'''
number using a Python formatting template such as ``{0:5.2f}`` or ``{0:,d}`` or number using a Python formatting template such as ``{0:5.2f}`` or ``{0:,d}`` or
``${0:5,.2f}``. The formatting template must begin with ``{0:`` and end with ``${0:5,.2f}``. The formatting template must begin with ``{0:`` and end with
``}`` as in the above examples. Exception: you can leave off the leading "{0:" ``}`` as in the above examples. Exception: you can leave off the leading "{0:"
and trailing "}" if the format template contains only a format. See the template and trailing "}" if the format template contains only a format. See the
language and the [URL href="https://docs.python.org/3/library/string.html#formatstrings"] [URL href="https://manual.calibre-ebook.com/template_lang.html"]
Python documentation[/URL] Template Language[/URL] and the
for more examples. Returns the empty string if formatting fails. [URL href="https://docs.python.org/3/library/string.html#formatstrings"]
Python[/URL] documentation for more examples. Returns the empty string if formatting fails.
''') ''')
def evaluate(self, formatter, kwargs, mi, locals, val, template): def evaluate(self, formatter, kwargs, mi, locals, val, template):
@ -1490,7 +1492,7 @@ class BuiltinFormatDateField(BuiltinFormatterFunction):
r''' r'''
``format_date_field(field_name, format_string)`` -- format the value in the ``format_date_field(field_name, format_string)`` -- format the value in the
field ``field_name``, which must be the lookup name of a date field, either field ``field_name``, which must be the lookup name of a date field, either
standard or custom. See ``format_date()`` for the formatting codes. This standard or custom. See :ref:`format_date` for the formatting codes. This
function is much faster than format_date() and should be used when you are function is much faster than format_date() and should be used when you are
formatting the value in a field (column). It is also more reliable because it formatting the value in a field (column). It is also more reliable because it
works directly on the underlying date. It can't be used for computed dates or works directly on the underlying date. It can't be used for computed dates or
@ -2882,8 +2884,8 @@ r'''
(the empty string). If the optional parameter ``pattern`` (a regular expression) (the empty string). If the optional parameter ``pattern`` (a regular expression)
is supplied then the list is filtered to files that match ``pattern`` before the is supplied then the list is filtered to files that match ``pattern`` before the
files are counted. The pattern match is case insensitive. See also the functions files are counted. The pattern match is case insensitive. See also the functions
``extra_file_names()``, ``extra_file_size()`` and ``extra_file_modtime()``. This :ref:`extra_file_names`, :ref:`extra_file_size` and :ref:`extra_file_modtime`.
function can be used only in the GUI. This function can be used only in the GUI.
''') ''')
def evaluate(self, formatter, kwargs, mi, locals, *args): def evaluate(self, formatter, kwargs, mi, locals, *args):
@ -2913,8 +2915,8 @@ r'''
extra files in the book's ``data/`` folder. If the optional parameter extra files in the book's ``data/`` folder. If the optional parameter
``pattern``, a regular expression, is supplied then the list is filtered to ``pattern``, a regular expression, is supplied then the list is filtered to
files that match ``pattern``. The pattern match is case insensitive. See also files that match ``pattern``. The pattern match is case insensitive. See also
the functions ``has_extra_files()``, ``extra_file_modtime()`` and the functions :ref:`has_extra_files`, :ref:`extra_file_modtime` and
``extra_file_size()``. This function can be used only in the GUI. :ref:`extra_file_size`. This function can be used only in the GUI.
''') ''')
def evaluate(self, formatter, kwargs, mi, locals, sep, *args): def evaluate(self, formatter, kwargs, mi, locals, sep, *args):
@ -2968,10 +2970,10 @@ r'''
``extra_file_modtime(file_name, format_string)`` -- returns the modification ``extra_file_modtime(file_name, format_string)`` -- returns the modification
time of the extra file ``file_name`` in the book's ``data/`` folder if it time of the extra file ``file_name`` in the book's ``data/`` folder if it
exists, otherwise ``-1``. The modtime is formatted according to exists, otherwise ``-1``. The modtime is formatted according to
``format_string`` (see ``format_date()`` for details). If ``format_string`` is ``format_string`` (see :ref:`format_date()` for details). If ``format_string`` is
the empty string, returns the modtime as the floating point number of seconds the empty string, returns the modtime as the floating point number of seconds
since the epoch. See also the functions ``has_extra_files()``, since the epoch. See also the functions :ref:`has_extra_files`,
``extra_file_names()`` and ``extra_file_size()``. The epoch is OS dependent. :ref:`extra_file_names` and :ref:`extra_file_size`. The epoch is OS dependent.
This function can be used only in the GUI. This function can be used only in the GUI.
''') ''')