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

...

Browse Source
This commit is contained in:
Charles Haley 2020-09-28 14:19:09 +01:00
parent d4798a11e5
commit 40a77e05d8
2 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
manual/template_lang.rst
View File

@ -425,6 +425,10 @@ Examples, again assuming the stored template is named ``foo``:
* ``call foo('series', '#genre')`` the variable ``key`` is assigned the value ``series`` and the variable ``alternate`` is assigned the value ``#genre``.
* ``call foo()`` -- the variable ``key`` is assigned the empty string and the variable ``alternate`` is assigned the value ``#genre``.
An easy way to test stored templates is using the ``Template tester`` dialog. Give it a keyboard shortcut in
:guilabel:`Preferences->Advanced->Keyboard shortcuts->Template tester`. Giving the ``Stored templates`` dialog a
shortcut will help switching more rapidly between the tester and editing the stored template's source code.
The following example is a `program:` mode implementation of a recipe on the MobileRead forum: "Put series into the title, using either initials or a shortened form. Strip leading articles from the series name (any)." For example, for the book The Two Towers in the Lord of the Rings series, the recipe gives `LotR [02] The Two Towers`. Using standard templates, the recipe requires three custom columns and a plugboard, as explained in the following:
The solution requires creating three composite columns. The first column is used to remove the leading articles. The second is used to compute the 'shorten' form. The third is to compute the 'initials' form. Once you have these columns, the plugboard selects between them. You can hide any or all of the three columns on the library view::
@ -506,7 +510,7 @@ The following program produces the same results as the original recipe, using on
It would be possible to do the above with no custom columns by putting the program into the template box of the plugboard. However, to do so, all comments must be removed because the plugboard text box does not support multi-line editing. It is debatable whether the gain of not having the custom column is worth the vast increase in difficulty caused by the program being one giant line.
User-defined template functions
User-defined python template functions
-------------------------------
You can add your own python functions to the template processor. Such functions are written in Python, and can be used in any of the three template programming modes. The functions are added by going to guilabel`Preferences -> Advanced -> Template functions`. Instructions are shown in that dialog.

23
src/calibre/gui2/preferences/stored_templates.py
View File

@ -41,26 +41,25 @@ class ConfigWidget(ConfigWidgetBase):
w.setWordWrap(True)
l.addWidget(w, 0, 0, 1, 2)
lab = QLabel(_('&Template'))
lab = QLabel(_('&Name'))
l.addWidget(lab, 1, 0)
self.function_name = w = QComboBox(self)
w.setEditable(True)
lab.setBuddy(w)
w.setToolTip(_('The name of the function, used in a call statement'))
l.addWidget(w, 1, 1)
lab = QLabel(_('&Template'))
l.addWidget(lab, 2, 0)
lb = QHBoxLayout()
self.program = w = TemplateLineEditor(self)
w.setPlaceholderText(_('The GPM template.'))
lab.setBuddy(w)
lb.addWidget(w, stretch=1)
self.editor_button = b = QPushButton(_('&Open Editor'))
self.editor_button = b = QPushButton(_('&Open template editor'))
b.clicked.connect(w.open_editor)
lb.addWidget(b)
l.addLayout(lb, 1, 1)
lab = QLabel(_('&Name'))
l.addWidget(lab, 2, 0)
self.function_name = w = QComboBox(self)
w.setEditable(True)
lab.setBuddy(w)
w.setToolTip(_('The name of the function, used in a call statement'))
l.addWidget(w, 2, 1)
l.addLayout(lb, 2, 1)
lab = QLabel(_('&Documentation'))
l.addWidget(lab, 3, 0, Qt.AlignTop)