excerpts: Database excerpts¶
lino_xl.lib.excerpts adds the notion of database excerpts.
Read also printing : Basic printing functionality.
This is a tested document. The following instructions are used for initialization:
>>> from lino import startup >>> startup('lino_book.projects.max.settings.doctests') >>> from lino.api.shell import * >>> from lino.api.doctest import *
End users should know what a "database excerpt" is. They can see a history of these database excerpts using the following menu commands:
- database excerpt
A database object that represents the fact that a given user has requested a given printable document at a given moment. Lino stores all these requests in a database table defined by the
End users can see a history of their printouts in.
When the end user clicks on a print button, Lino actually creates a database excerpt and then prints this excerpt.
add lino_xl.lib.excerpts to your
Add the virtual field printed
Lino does not automatically add an action per model to make the excerpt history visible from a model. If you want this, add yourself your preferred variant.
This can be either using a
ShowSlaveTable button in the toolbar:
show_excerpts = dd.ShowSlaveTable('excerpts.ExcerptsByOwner') show_excerpts = dd.ShowSlaveTable('excerpts.ExcerptsByProject')
In addition to the main template, excerpt types can specify a body
Before rendering the main template, Lino
When the main template is being rendered, it has a context
SiteAdmin user (and when
lino.modlib.davlink is installed) you can easily modify the
main template which has been used to print a given excerpt using the
Edit Template button in
the detail window of that
If you want to configure which document to use as main template, then you must use the Configuration menu:
Lino has a main template named
excerpts/Default.odt which is
A printable document that describes some aspect of the current situation.
The object being printed by this excerpt. See
The optional contact person of the
recipientof this excerpt. See
The recipient of this excerpt. See
The language used for printing this excerpt.
Lino also has a table of excerpt types where the system administrator can configure which types of database excerpts are available on a site. You can see this list via.
- excerpt type
A configuration database object that specifies that a print button should appear for a given model.
The detailed structure of this table is documented on the
When a Lino process starts up, it automatically reads this table and installs a "Print" action on every model of a site for which there is an excerpt type.
The designation of this excerpt type. One field for every
The database model for which this excerpt type is to be used.
The main template to be used when printing an excerpt of this type.
The body template to use when printing an excerpt of this type.
The template to use when sending this an excerpt of this type by email.
Any model which inherits from this mixin becomes "certifiable".
from lino_xl.lib.excerpts.mixins import Certifiable class MyModel(dd.UserAuthored, Certifiable, dd.Duplicable): ...
Displays information about when this certifiable has been printed. Clicking on it will display the excerpt pointed to by
ForeignKey to the
Excerptwhich certifies this instance.
Certifiableis considered "certified" when this this is not None.
Note that this field is a nullable ForeignKey with on_delete set to
on_duplicate(self, ar, master)¶
After duplicating e.g. a budget which had been printed, we don't want the duplicate point to the same excerpt.
A class method. Expected to return a string with a space-separated list of field names. These files will automaticaly become disabled (readonly) when the document is "certified". The default implementation returns an empty string, which means that no field will become disabled when the row is "certified".
@classmethod def get_certifiable_fields(cls): return 'date user title'
A string to be used in templates as the title of the certifying document.
Return either None or a list of template names to be used when printing an excerpt controlled by this object.
Mixin for models like
The designation of this row as seen by the user e.g. when selecting an instance of this model.
One field for every
- excerpt shortcut field
A virtual display field with actions for quickly managing, for a given database object, its excerpt of a given type.
This template is the default value, used by many excerpt types in
template field. It is designed
to be locally overridden by local site administrators in order to
match their letter paper.
Create an excerpt in order to print this data record.
Clear any previously generated printable document. Mark this object as not printed. A subsequent call to print will generate a new cache file.
A receiver for the
Installs (1) print management actions on models for which there is an excerpt type and (2) the excerpt shortcut fields defined in
Note that excerpt types for a model with has MTI children, the action will be installed on children as well. For example a
lino_book.projects.adgcan get printed either as a
TermsConditions.odtor as a
When the database does not yet exist (e.g. during
prep), it simply ignores that situation silently and does not define the print actions.
This is called for every new Excerpt object and it sets certain default values.
For the default language, note that the
recipient. This rule is important e.g. for printing aid confirmations in Lino Welfare.