====== Currently Reading Plugin ======

---- plugin ----
description: Displays a box with a book cover image that says ‘Currently Reading’ linked to a page
author     : Charles Fewlass
email      : curator@scrollsoflankhmar.com 
type       : syntax
lastupdate : 2021-08-07
compatible : Hogfather
depends    : 
conflicts  : 
similar    : 
tags       : books, reading, box, image

downloadurl: https://github.com/elbuagnin/dokuwiki-plugin-currentlyreading/archive/refs/tags/v1.0.1.zip
bugtracker : https://github.com/elbuagnin/dokuwiki-plugin-currentlyreading/issues
sourcerepo : https://github.com/elbuagnin/dokuwiki-plugin-currentlyreading/
donationurl: 

screenshot_img :  # https://scrollsoflankhmar.com/_media/currentlyreadingexample.png #FIXME
----

===== Installation =====

Install the plugin using the [[extension|Extension Manager]] Plugin and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

===== 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.

The story title is pulled from the page’s metadata title, and the image comes from the page’s first image metadata.

If the page is not found, the plugin will still display a box but without an image and will use the pagename as the title. The link will go to a non-existing page that the user can create when clicked upon. If the page exists but does not have an image, the plugin simply does not display an image.

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**FIXME
  {{https://scrollsoflankhmar.com/_media/currentlyreadingexample.png|Screenshot}}

===== Syntax =====

<code>{{reading>pagename[?width]}}</code>

==== Parameters ====

=== pagename ===

//required//
<code>{{reading>gatherdarkness}}</code>
<code>{{reading>fiction:novels:conjurewife}}</code>

//Any valid namespace is allowed.//

=== width ===
//optional//
<code>{{reading>comingattractions?300}}</code>
//Width is in pixels.//

//Including a width will override the configuration width.//

==== Floats ====
The box can be set to float left, right, center, or none, with the same DokuWiki syntax used for images.
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//<code>{{reading> smokeghost}}</code>
  * //floats left//<code>{{reading>smokeghost }}</code>
  * //center//<code>{{reading> smokeghost }}</code>

==== No Existing Page ====
<code>{{reading>hungergames}}</code>
//Still displays a box with a link to a non-existing page in the wiki.//\\ 
**Resultant Title:** hungergames **Interwiki Link:** hungergames

<code>{{reading>Hunger Games}}</code>
//Still displays a box with a link to a non-existing page in the wiki.//\\ 
**Resultant Title:** Hunger Games **Interwiki Link:** hungergames

===== Configuration and Settings =====
==== Configuration ====
=== Width ===
Default width in pixels.\\ 
//Can be overriden in markdown.//

=== Alternate Heading ===
A heading that replaces "Currently Reading."\\ 
//If left blank, no replacement occurs.//

==== Formatting ====
The box can be formatted via the style.css file in the plugin's directory.

===== Development =====
=== Change Log ===
{{rss>https://github.com/elbuagnin/dokuwiki-plugin-currentlyreading/tags.atom}}

=== Known Bugs and Issues ===
[[https://github.com/elbuagnin/dokuwiki-plugin-currentlyreading/issues|Github Issue Tracker]].


===== Discussion =====
[[https://forum.dokuwiki.org/|DokuWiki Forum]] or [[https://github.com/elbuagnin/dokuwiki-plugin-currentlyreading/discussions|GitHub Repo Discussion]].