plugin:currentlyreading
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| plugin:currentlyreading [2021-08-04 01:28] – [Discussion] added clfewlass | plugin:currentlyreading [2023-04-26 12:41] (current) – Aleksandr | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== | + | ====== |
| ---- plugin ---- | ---- plugin ---- | ||
| - | description: | + | description: |
| author | author | ||
| email : curator@scrollsoflankhmar.com | email : curator@scrollsoflankhmar.com | ||
| type : syntax | type : syntax | ||
| - | lastupdate : 2021-08-03 | + | lastupdate : 2021-08-07 |
| compatible : Hogfather | compatible : Hogfather | ||
| depends | depends | ||
| conflicts | conflicts | ||
| similar | similar | ||
| - | tags : books, reading | + | tags : books, reading, box, image |
| - | downloadurl: | + | downloadurl: |
| - | bugtracker : http:// | + | bugtracker : https:// |
| - | sourcerepo : http:// | + | sourcerepo : https:// |
| donationurl: | donationurl: | ||
| - | screenshot_img : | + | screenshot_img : # https:// |
| ---- | ---- | ||
| ===== Installation ===== | ===== Installation ===== | ||
| - | Install the plugin using the [[plugin: | + | Install the plugin using the [[extension|Extension |
| ===== Usage ===== | ===== Usage ===== | ||
| - | Include the markdown on a page and it will be replaced by a box containing the heading, “Currently Reading,” with below a linked title of the page, and below that an image of the book cover. | + | |
| + | Include the markdown on a page and it will be replaced by a box containing the heading, “Currently Reading”, with below a linked title of the page, and below that an image of the book cover. | ||
| The story title is pulled from the page’s metadata title, and the image comes from the page’s first image metadata. | The story title is pulled from the page’s metadata title, and the image comes from the page’s first image metadata. | ||
| Line 34: | Line 35: | ||
| Spaces in the pagename will be eliminated and capitalization will be converted to lowercase when the plugin looks for an existing wiki page. However, if no page exists, spaces and capitalization will be kept when creating the displayed title. The attached link, will of course, be converted. | Spaces in the pagename will be eliminated and capitalization will be converted to lowercase when the plugin looks for an existing wiki page. However, if no page exists, spaces and capitalization will be kept when creating the displayed title. The attached link, will of course, be converted. | ||
| - | **Screenshot** | + | **Screenshot**FIXME |
| - | {{https:// | + | {{https:// |
| ===== Syntax ===== | ===== Syntax ===== | ||
| + | |||
| < | < | ||
| ==== Parameters ==== | ==== Parameters ==== | ||
| + | |||
| === pagename === | === pagename === | ||
| + | |||
| // | // | ||
| < | < | ||
| Line 53: | Line 56: | ||
| < | < | ||
| //Width is in pixels.// | //Width is in pixels.// | ||
| + | |||
| //Including a width will override the configuration width.// | //Including a width will override the configuration width.// | ||
| Line 59: | Line 63: | ||
| A space preceding the pagename will cause the box to float right, at the end will float left, and at both places will float center. | A space preceding the pagename will cause the box to float right, at the end will float left, and at both places will float center. | ||
| - | < | + | * //floats right//< |
| - | // | + | |
| - | < | + | |
| - | //floats left// | + | |
| - | < | + | |
| - | //center// | + | |
| ==== No Existing Page ==== | ==== No Existing Page ==== | ||
| < | < | ||
| - | //Still displays a box with a link to a non-existing page in the wiki.// \\ | + | //Still displays a box with a link to a non-existing page in the wiki.//\\ |
| - | **Resultant Title:** hungergames **Interwiki Link:** hungergames | + | **Resultant Title:** hungergames **Interwiki Link:** hungergames |
| < | < | ||
| - | //Still displays a box with a link to a non-existing page in the wiki.// \\ | + | //Still displays a box with a link to a non-existing page in the wiki.//\\ |
| - | **Resultant Title:** Hunger Games **Interwiki Link:** hungergames | + | **Resultant Title:** Hunger Games **Interwiki Link:** hungergames |
| ===== Configuration and Settings ===== | ===== Configuration and Settings ===== | ||
| ==== Configuration ==== | ==== Configuration ==== | ||
| === Width === | === Width === | ||
| - | Default width in pixels. \\ | + | Default width in pixels.\\ |
| //Can be overriden in markdown.// | //Can be overriden in markdown.// | ||
| === Alternate Heading === | === Alternate Heading === | ||
| - | A heading that replaces " | + | A heading that replaces " |
| //If left blank, no replacement occurs.// | //If left blank, no replacement occurs.// | ||
| Line 90: | Line 91: | ||
| ===== Development ===== | ===== Development ===== | ||
| === Change Log === | === Change Log === | ||
| - | + | {{rss> | |
| - | * **2021-08-03** | + | |
| - | * Initial release | + | |
| === Known Bugs and Issues === | === Known Bugs and Issues === | ||
| - | [[https:// | + | [[https:// |
| ===== Discussion ===== | ===== Discussion ===== | ||
| - | Please post in the DokuWiki | + | [[https://forum.dokuwiki.org/ |
plugin/currentlyreading.1628033337.txt.gz · Last modified: 2021-08-04 01:28 by clfewlass