upstream/dokuwiki-plugins-extra
1
0
Fork 0
Code Activity

Adding dw2pdf version 2023-11-25 (48253f1).

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2024-12-01 20:29:19 +01:00
parent d4820b660a
commit 8e32b01eb0
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
999 changed files with 144285 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

69
plugins/55/dw2pdf/tpl/default/README.txt Normal file
View file

@ -0,0 +1,69 @@
====== dw2pdf Templates ======
Templates define the design of the created PDF files and are a good way
to easily customize them to your Corporate Identity.
To create a new template, just create a new folder within the plugin's
''tpl'' folder and put your header, footers and style definitions in it.
===== Headers and Footers =====
The following files can be created and will be used to set headers and
footers on odd or even pages. Special headers/footers can be used on the
first page of a document. If a file is does not exist the next more generic
one will be tried. Eg. if You don't differ between even and odd pages,
just the header.html is used.
* ''header.html'' -- Header for all pages
* ''header_odd.html'' -- Header for odd pages
* ''header_even.html'' -- Header for even pages
* ''header_first.html'' -- Header for the first page
* ''footer.html'' -- Footer for all pages
* ''footer_odd.html'' -- Footer for odd pages
* ''footer_even.html'' -- Footer for even pages
* ''footer_first.html'' -- Footer for the first page
* ''citation.html'' -- Citationbox to be printed after each article
* ''cover.html'' -- Added once before first page
* ''back.html'' -- Added once after last page
You can use all HTML that is understood by mpdf
(See http://mpdf1.com/manual/index.php?tid=256)
If you reference image files, be sure to prefix them with the @TPLBASE@
parameter (See [[#Replacements]] below).
===== Replacements =====
The following replacement patterns can be used within the header and
footer files.
* ''@PAGE@'' -- current page number in the PDF
* ''@PAGES@'' -- number of all pages in the PDF
* ''@TITLE@'' -- The article's title
* ''@WIKI@'' -- The wiki's title
* ''@WIKIURL@'' -- URL to the wiki
* ''@DATE@'' -- time when the PDF was created (might be in the past if cached)
* ''@BASE@'' -- the wiki base directory
* ''@INC@'' -- the absolute wiki install directory on the filesystem
* ''@TPLBASE@'' -- the PDF template base directory (use to reference images)
* ''@TPLINC@'' -- the absolute path to the PDF template directory on the filesystem
//Remark about Bookcreator//:
The page depended replacements are only for ''citation.html'' updated for every page.
In the headers and footers the ID of the bookmanager page of the Bookcreator is applied.
* ''@ID@'' -- The article's pageID
* ''@PAGEURL@'' -- URL to the article
* ''@UPDATE@'' -- Time of the last update of the article
* ''@QRCODE@'' -- QR code image pointing to the original page url (requires an online generator, see config setting)
===== Styles =====
Custom stylings can be provided in the following file of your dw2pdf-template folder:
* style.css
You can use all the CSS that is understood by mpdf
(See http://mpdf1.com/manual/index.php?tid=34)