plugin:bookcreator
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| plugin:bookcreator [2016-01-29 02:35] – [Description] 158.61.0.233 | plugin:bookcreator [2024-02-08 00:14] (current) – Klap-in | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ---- plugin ---- | ---- plugin ---- | ||
| - | description: | + | description: |
| author | author | ||
| email : klapinklapin@gmail.com # previous: l.micco@tiscali.it | email : klapinklapin@gmail.com # previous: l.micco@tiscali.it | ||
| type : action, syntax | type : action, syntax | ||
| - | lastupdate : 2015-06-11 | + | lastupdate : 2024-02-07 |
| - | compatible : Hrun, Adora Belle, Weatherwax, Binky,Ponder Stibbons | + | compatible : Elenor Of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum, Kaos |
| - | depends | + | depends |
| conflicts | conflicts | ||
| similar | similar | ||
| - | tags : export, pdf, books | + | tags : export, pdf, odt, books |
| - | screenshot_img : http:// | + | |
| securitywarning: | securitywarning: | ||
| Line 20: | Line 19: | ||
| sourcerepo : https:// | sourcerepo : https:// | ||
| donationurl: | donationurl: | ||
| + | |||
| + | screenshot_img : https:// | ||
| ---- | ---- | ||
| ===== Description ===== | ===== Description ===== | ||
| - | The **bookcreator** plugin allows the user to select some pages from a wiki and then export them to create a little PDF book or text (like a similar [[wp> | ||
| - | First you initialize a book by clicking an interface button | + | The **bookcreator** plugin allows the user to select some pages from a wiki and then export them to create a little PDF book or text (like a similar [[wp> |
| + | |||
| + | First you initialize a book by clicking an interface button. Nextly, a toolbar at the top of the pages appear to add/remove more pages to the book. Also you can jump to the bookmanager (at a preconfigured page) that let you sort and finish the selections for your book, and export it to screen(html) and when the required plugins are installed: to pdf-file, odt-file or text on screen. | ||
| The bookmanager let you save and load saved selections for later use. You can use drag and drop to change the order and move pages in and out. | The bookmanager let you save and load saved selections for later use. You can use drag and drop to change the order and move pages in and out. | ||
| - | | + | |
| - | To work, this plugin | + | The bookcreator supports the following export formats, if you install respectively |
| + | * To work the PDF export required [[plugin: | ||
| + | * the ODT export required [[plugin: | ||
| + | * the Text export required the [[plugin: | ||
| ===== Usage ===== | ===== Usage ===== | ||
| Line 38: | Line 43: | ||
| | | ||
| In the bookmanager can show and manage your list of selected pages | In the bookmanager can show and manage your list of selected pages | ||
| - | | + | |
| - | * Exclude/ | + | * Exclude/ |
| - | * View the excluded pages and " | + | * View the excluded pages and " |
| - | * Drag and drop to change exporting order of page and remove/add page to the selection. | + | * Drag and drop to change exporting order of page and remove/add page to the selection. |
| - | * Set a title for the PDF document | + | * Set a title for the PDF document |
| - | * Create the PDF book on selected pages | + | * Create the PDF book on selected pages |
| - | * Create a printable version of selected pages | + | * Create a printable version of selected pages |
| - | * Extract only text of selected pages | + | * Extract only text of selected pages |
| - | * Save and restore selections on a specific namespace (use ACL's rights) | + | * Save and restore selections on a specific namespace (use ACL's rights) |
| == Example == | == Example == | ||
| Line 55: | Line 60: | ||
| </ | </ | ||
| And __after__ you mark at least one page for inclusion in the book, the bookmanager appears. | And __after__ you mark at least one page for inclusion in the book, the bookmanager appears. | ||
| - | {{http://img37.imageshack.us/img37/2496/bookcreatorbookmanager.png?500}} | + | {{https://trello.com/ |
| ==== Initiate a book==== | ==== Initiate a book==== | ||
| - | {{ http://img17.imageshack.us/img17/9830/bookcreatorpagetoolsadd.png? | + | {{ https://trello.com/ |
| - | Use the // | + | Use the // |
| After selecting the first page, a toolbar appears on every page that let you add or remove additional pages. This toolbar refers also to the book manage tool. | After selecting the first page, a toolbar appears on every page that let you add or remove additional pages. This toolbar refers also to the book manage tool. | ||
| - | {{http://img703.imageshack.us/img703/9973/bookcreatortoolbar.png?500}} | + | {{https://trello.com/ |
| The book manage tool that you created above (default on '' | The book manage tool that you created above (default on '' | ||
| Line 71: | Line 76: | ||
| Below the bookmanager is a listed displayed with saved selections. You can also display with ''< | Below the bookmanager is a listed displayed with saved selections. You can also display with ''< | ||
| - | | + | |
| - | * Optionally you can specify the number of selections to display and the order: | + | * Optionally you can specify the number of selections to display and the order: |
| - | * '' | + | * '' |
| - | * '' | + | * '' |
| - | * a //number// limits the number of displayed selections | + | * a //number// limits the number of displayed selections |
| Default is 10 items ordered by date (last updated are sorted first). Each entry links also to the wiki page where their selection is saved. Per page only one list of saved selections is displayed. | Default is 10 items ordered by date (last updated are sorted first). Each entry links also to the wiki page where their selection is saved. Per page only one list of saved selections is displayed. | ||
| Line 82: | Line 87: | ||
| == Example == | == Example == | ||
| + | |||
| + | {{ https:// | ||
| Lists 5 selections, sorted by date | Lists 5 selections, sorted by date | ||
| < | < | ||
| ~~ARCHIVEBOOK: | ~~ARCHIVEBOOK: | ||
| </ | </ | ||
| - | {{http:// | ||
| - | ===== Installation ===== | + | ==== Direct export a saved selection |
| - | To add or remove | + | To create |
| + | (FIXME: ODT format have to receive | ||
| + | < | ||
| + | ~~EXPORTPDF: | ||
| + | ~~EXPORTTEXT: | ||
| + | ~~EXPORTHTML: | ||
| + | ~~EXPORTODT: | ||
| + | </ | ||
| - | ==== ' | + | To change link title shown in wiki page: |
| + | < | ||
| - | When you are using the newest default template of DokuWiki, the "Add/ | + | Add url parameters |
| + | < | ||
| + | ~~EXPORTPDF: | ||
| - | ==== ' | + | ===== Installation ===== |
| - | Use the following to add another button in the upper or bottom button row of the default template((In '' | + | Search and install |
| - | <code html> | + | ==== ' |
| - | <form class=" | + | |
| - | <div class=" | + | |
| - | <input type=" | + | |
| - | <input type=" | + | |
| - | <input type=" | + | |
| - | </ | + | |
| - | </ | + | |
| - | </ | + | |
| - | ==== Monobook ==== | + | When you are using the default |
| - | + | ||
| - | When using the template | + | |
| - | <code php> | + | |
| - | //pdfbook plugin: add/ | + | |
| - | if (file_exists(DOKU_PLUGIN." | + | |
| - | !plugin_isdisabled(" | + | |
| - | $_monobook_tabs[" | + | |
| - | $_monobook_tabs[" | + | |
| - | } | + | |
| - | </ | + | |
| - | + | ||
| - | ==== Vector ==== | + | |
| - | + | ||
| - | Add this code to ''/ | + | |
| - | <code php> | + | |
| - | //pdfbook plugin: add/remove selection | + | |
| - | if (file_exists(DOKU_PLUGIN." | + | |
| - | | + | |
| - | | + | |
| - | } | + | |
| - | </ | + | |
| - | As a second step, open the language file for the vector template, for example | + | |
| - | <code php> | + | |
| - | $lang[" | + | |
| - | </ | + | |
| - | This is the text which is used for the link to display. | + | |
| + | ==== other templates ==== | ||
| + | Other templates will probably not be supported that good yet. Please request at the issue tracker. | ||
| ===== Changing the order of wiki pages ===== | ===== Changing the order of wiki pages ===== | ||
| Line 155: | Line 139: | ||
| * [[: | * [[: | ||
| - | You can also manually create a book from scratch by using the same format. | + | You can also manually create a book from scratch by using the same format. |
| - | * Take care of prefixing of links by '':'' | + | * Take care of prefixing of links by '':'' |
| * To create a book from scratch, start a new page such as // | * To create a book from scratch, start a new page such as // | ||
| - | =====Configuration===== | + | ===== Configuration ===== |
| Available configuration options. | Available configuration options. | ||
| ^Name | ^Name | ||
| Line 167: | Line 152: | ||
| |save_namespace |Namespace where the book manager will save selections. | |save_namespace |Namespace where the book manager will save selections. | ||
| |skip_ids | |skip_ids | ||
| + | |||
| + | ==== Modifying the generated file ==== | ||
| + | |||
| + | If you like to configure/ | ||
| ===== Version history ===== | ===== Version history ===== | ||
| Line 173: | Line 162: | ||
| {{rss> | {{rss> | ||
| - | |||
| - | * **'' | ||
| - | * Removed inline javascript | ||
| - | * Rewritten javascript by using jQuery. JQuery UI for sorting. | ||
| - | * Refactored Bookmanager code | ||
| - | * Included some localisations | ||
| - | * There are some new strings added | ||
| - | * In the ' | ||
| - | * Removed BOM at begin of ''/ | ||
| - | * Fixed Call-time pass-by-reference search function | ||
| - | * Adopted by [[user> | ||
| - | |||
| - | Original author: [[l.micco@tiscali.it|Luigi Micco]] | ||
| - | * **'' | ||
| - | * add support for **ARCHIVE** mode | ||
| - | * rewritten part of code to avoid conflict with other scripts | ||
| - | * support for use ACL's permissions on pages and book's namespace | ||
| - | * **'' | ||
| - | * some bugs removed (thanks to Karl for tips) | ||
| - | * < | ||
| - | * hide list of selections if empty | ||
| - | * **'' | ||
| - | * allow to export selection to a **text only** version ([[plugin: | ||
| - | * solved problems with cache system | ||
| - | * **'' | ||
| - | * admin side configuration | ||
| - | * **toolbar** like Wikipedia "Book creator" | ||
| - | * support for " | ||
| - | * allow to set a **title for the PDF** document (see [[plugin: | ||
| - | * allow to **save and restore** selections | ||
| - | * allow to export selection to a **printable version** | ||
| This plugin was the former Pdfbook Plugin. | This plugin was the former Pdfbook Plugin. | ||
| - | =====Bug reports and feature requests===== | + | ===== Bug reports and feature requests ===== |
| Please refer to the [[https:// | Please refer to the [[https:// | ||
| + | |||
| + | ===== FAQ ===== | ||
| + | |||
| + | * This plugin is almost what I am looking for. Is there a way to add a title page / cover page? (I am using it with dw2pdf to also include a table of contents. I'd be fine with having a wiki page as "title page" before the TOC.)\\ **reaction**: | ||
plugin/bookcreator.1454031356.txt.gz · Last modified: 2016-01-29 02:35 by 158.61.0.233