# Documentation This documentation is about the Fictioneer theme. If you need help with WordPress in general, take a look at the [official documentation](https://wordpress.org/support/category/basic-usage/) or search the Internet for one of the many tutorials. For the installation, look [here](INSTALLATION.md) first and then come back once you are done. ### Table of Contents * [Stories](#stories) * [Meta Fields](#meta-fields) * [eBooks/ePUBs](#ebooksepubs) * [Chapters](#chapters) * [Meta Fields](#meta-fields-1) * [Text-To-Speech Engine](#text-to-speech-engine) * [Collections](#collections) * [Meta Fields](#meta-fields-2) * [Recommendations](#recommendations) * [Meta Fields](#meta-fields-3) * [Example Sentences](#example-sentences) * [Shared Options](#shared-options) * [Search Engine Appearance](#search-engine-appearance) * [Landscape Image](#landscape-image) * [Page Layout](#page-layout) * [Comments](#comments) * [Additional CSS Classes](#additional-css-classes) * [HTML Block / litRPG Box](#html-block) * [Shortcodes](#shortcodes) * [Bookmarks](#bookmarks) * [Contact Form](#contact-form) * [Cookie Buttons](#cookie-buttons) * [Latest Chapters](#latest-chapters) * [Latest Posts](#latest-posts) * [Latest Stories](#latest-stories) * [Latest Recommendations](#latest-recommendations) * [Latest Updates](#latest-updates) * [Chapter List](#chapter-list) * [Search Form](#search-form) * [Showcase](#showcase) * [Images & Media](#images--media) * [Users & OAuth](#users--oauth) * [Checkmarks, Follows & Reminders](#checkmarks-follows--reminders) * [Bookmarks](#bookmarks) * [User Profile](#user-profile) * [Common Problems](#common-problems) * [Missing Blocks](#missing-blocks) * [Reserved URL Slugs](#reserved-url-slugs) ## Stories Stories are added under **Stories > Add New**. Required fields are the short description, status, and age rating. You should be thorough with the setup, especially the taxonomies if you have more than a few stories on your site, because they can be searched for. Just avoid adding excessive lists of tags.  The layout will adjust itself if certain fields are left empty, such as the cover image or taxonomies. With a blank title, the date and time will be used instead. Cover images are displayed with an aspect ratio of 2:3, although the image itself does not need to follow these dimensions as it will be cropped from the center.  The share, feed, and action buttons are displayed depending on your theme settings. The Blog tab lists 160 characters long excerpts of the latest posts associated with the story via category. Up to four custom pages can be added as extra tabs, with any content, which requires them to have the short name field. Chapters assigned to the story can be added and sorted in the editor, but chapter groups and icons are assigned in the chapters. **Subscribe:** Opens a popup menu with links to any support campaigns (Patreon, Ko-fi, and SubscribeStar) as well as the RSS aggregator services [Feedly](https://feedly.com/) and [Inoreader](https://www.inoreader.com/). There is no default email subscription system. **Follow & Read Later:** These buttons belong to the optional Follows and Reminders features, allowing logged-in subscribers to better track stories. This is mainly for sites that host a large number of stories.  Story cards are more compact story displays meant for browsing, collapsed even further on small viewports. Instead of the content, only the *first paragraph* of the short description will be shown. Make sure to write something appealing, it may be the only chance your story gets to catch attention. Tags are normally not rendered to save space, but you can change that in the settings. Story cards are used in the Stories [page template](https://wordpress.org/support/article/pages/#page-templates), collections, search, and featured lists in posts. ### Meta Fields | Field | Type | Explanation | :-- | :-: | :-- | Short Description * | Content | The short description is used in the story list cards. | Chapters | List | Add and sort chapters assigned to the story. Assignment is done in the chapters. | Custom Pages | List | Add up to four pages as extra tabs. Requires the short name field to show up. | Upload Ebook | File | Upload an epub, mobi, ibooks, azw, azw3, kf8, kfx, pdf, iba, or txt file. | ePUB Preface | Content | Disclaimers/etc. for generated ePUBs. Required for the download button to show up. | ePUB Afterword | Content | Will be appended after the last chapter in generated ePUBs. | ePUB Custom CSS | Text | Inject custom styles into the generated ePUB. For advanced users. | Taxonomies (Various) | List | Genres, fandoms, characters, warnings, tags, and categories (include story name). | Cover Image | Image | Cropped to an aspect ration of 2:3 from the center. | Status * | Select | Choose between ongoing, completed, oneshot, hiatus, and cancelled. | Age Rating * | Select | Choose between everyone, teen, mature, and adult. | Co-Authors | List | List of co-authors. They must be registered users, but dummies will do. | Copyright Notice | String | Line below the content to declare copyrights if necessary. | Top Web Fiction Link | URL | Link to your story on [Top Web Fiction](https://topwebfiction.com/). | Sticky in all lists | Check | Stick the story to the top of the first page in lists. | Disable ePUB download | Check | Disable ePUB downloads for the story everywhere. | Hide thumbnail on story page | Check | Hide the cover image on the page but not in lists. | Hide tags on story page | Check | Hide *all* taxonomies except warnings on the page but not in lists. | Hide chapter icons | Check | Hide chapter icons. | Disable collapsing of chapters | Check | Disable collapsing of long chapter lists (13+ as 5\|n\|5 per group). | Hide chapter icons | Check | Hide chapter icons. | Disable chapter groups | Check | Ignore chapter groups. | Custom Story CSS | Text | Inject custom styles for the story and chapters. For advanced users. | Custom Header Image | Image | Override the default header image for the story and chapters. | Custom CSS | Text | Inject custom styles into the story page (but not chapters). | Support Links (Various) | URL | Links to subscription campaigns. Falls back to the author’s profile if left blank. | Disable commenting | Check | Disable new comments but keep the current ones visible. ### eBooks/ePUBs A manually uploaded eBook will always supersede an automatically generated ePUB on the site, as this is a deliberate action. Which also means you need to keep it up-to-date yourself and there are no download statistics. If you want the generated ePUB, you need to fill the Preface content for the story, which should contain copyrights and disclaimers. Because once a file is on the Internet, it will stay on the Internet. Make sure everything is legally sound before that. **Supported:** Epubs only support paragraphs, headings, lists, tables, blockquotes, pullquotes, images, spacers, and custom HTML at your own peril. Anything else will be filtered out, such as videos. **Sensitive Content:** You can mark sensitive content in chapters and provide an alternative, which users can choose from. Generated ePUBs always use the sensitive (uncensored) content, not the alternative if provided. #### Example Disclaimer for Originals: > This is a work of fiction. Names, characters, business, events and incidents are the products of the author’s imagination. Any resemblance to actual persons, living or dead, or actual events is purely coincidental. > > Copyright © `AUTHOR`. All rights reserved. #### Example Disclaimer for Fanfictions: > This is a work of fan fiction and not written for profit. Names, characters, business, events and incidents are the products of the author’s imagination. Any resemblance to actual persons, living or dead, or actual events is purely coincidental. Any trademarked characters and elements used belong to their respective copyright holders, who bear no responsibility for this work. > > Original Content Copyright © `AUTHOR`. All rights reserved. ## Chapters Chapters are added under **Chapters > Add New**. The only required field is the chapter icon, which is pre-selected by default (book). But you need to select a story if you want the chapter to show up in said story’s chapter list. This is not limited to your own stories, so you can publish guest chapters for others, although the owners still need to list them. As with stories, you should be thorough with the setup.  The display of a chapter listed on a story page is controlled from within the chapter. The icon, warning, and chapter group are assigned here, although icons can be disabled globally or per story. Make sure to spell the chapter group correctly each time, because there is no hand-holding and different names result in different groups. Groups can also cause chapters to be reordered if not in sequence, but the order within a group is still derived from the story’s chapter list. You need at least two groups for groups to be displayed and ungrouped chapters will be collected under "Unassigned". **Checkmarks:** These icon buttons belong to the optional Checkmarks feature, allowing logged-in subscribers to mark chapters and stories as read. This is mainly for sites that host a large number of stories.  The fullscreen toggle is not available on iOS, which at the time of writing does not support the fullscreen API. The navigation buttons are derived from the story’s chapter list. You can open the paragraph tools by clicking on a paragraph; Bookmarks, Suggestions, and Text-to-Speech (TTS) must be enabled in the settings first. Bookmarks are per chapter and linked to a paragraph, the color is only a gimmick and does _not_ indicate you have more than one. **Formatting Modal:** Opened with the Formatting button. Allows readers to customize how chapters are displayed, including: site brightness, site saturation, site width, font size, letter spacing, line height, paragraph spacing, font saturation, font family, font color, and font weight as well as toggles for text indent, text justify, light/dark mode, paragraph tools, author notes, comments, and sensitive content.  This notice appears above the title if you add a chapter warning, not to be confused with the content warning taxonomy. The warning is also shown in the chapter list of the story. Keep it short, there is not much space. You can change the color and add an additional explanation as well. The toggle allows to hide any sensitive content marked with the `sensitive-content` CSS class and show an alternative marked with `sensitive-alternative` if provided. ### Meta Fields | Field | Type | Explanation | :-- | :-: | :-- | Story | Select | The story the chapter belongs to. Required if you want it listed. | Card/List Title | String | Alternative title meant to be suitable for cards and lists with little space. | Group | String | Chapter group assignment. Mind the spelling and order of chapters. | Foreword | Content | Foreword rendered above the chapter title. | Afterword | Content | Afterword rendered below the chapter content. | Password Note | Content | Optional note if there is a password requirement. | Taxonomies (Various) | List | Genres, fandoms, characters, warnings, tags, and categories (include story name). | Chapter Cover Image | Image | Cropped to an aspect ration of 2:3 from the center. Defaults to the story cover. | Excerpt | Text | Chapter excerpt used in cards. If empty, part of the content will be used. | Chapter Icon * | String | Free [Font Awesome](https://fontawesome.com/search) class string. Defaults to `fa-solid fa-book`. | Chapter Text Icon | String | Overrides icon with a text string, good for combining with symbol fonts. | Chapter Short Title | String | Optional short chapter title, not currently used by the base theme. | Chapter Prefix | String | Prepended to the title in chapter lists. Not used in generated ePUBs. | Co-Authors | List | List of co-authors. They must be registered users, but dummies will do. | Unlisted? | Check | Hide the chapter in all lists, but keep it accessible with the link. | Not a Chapter? | Check | Exclude the chapter from chapter counts. | Hide Title? | Check | Hide the title and author on chapter pages. | Hide Support Links? | Check | Hide support links at the end of the chapter. | Chapter Age Rating | Select | Choose between everyone, teen, mature, and adult. | Chapter Warning | String | _Short_ warning displayed in chapter lists and above the chapter title. | Warning Notes | Text | Additional warning notes rendered above the chapter title. | Warning Color | Color | Change the color of the warning, but consider the legibility in light/dark mode. ### Text-To-Speech Engine Must be enabled in the settings and is started from the paragraph tools. Makes use of the free [Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) that all modern browsers support, which can be wonky at times but produces surprisingly decent results. Primarily meant as accessibility feature for the reading-impaired. Absolutely _not_ fail-proof and depends on the browser and operating system; additional permissions may be necessary. **Supported:** Only first level children of the content container are read, and only paragraphs and headings. If you want tables, quotes, and more to be read, add the desired output as paragraph with the `hidden` CSS class. **Note:** Browsers have only one instance of this engine. That means if you have another one running in a different tab, perhaps a different site altogether, they will interfere with each other. You can even control the output of other sites.  ## Collections Collections are added under **Collections > Add New**. Required fields are the short description and items featured in the collection, which may include posts, pages, stories, chapters, recommendations, and even other collections. The purpose is to group different items with a common context, such as sequels or stories set in a shared universe.  ### Meta Fields | Field | Type | Explanation | :-- | :-: | :-- | Card/List Title | String | Alternative title meant to be suitable for cards and lists with little space. | Collection Items * | List | Add and sort posts, pages, stories, chapters, recommendations, and collections. | Short Description * | Content | The short description is used in the collection list cards. | Taxonomies (Various) | List | Genres, fandoms, characters, warnings, tags, and categories (include story name). | Collection Cover Image | Image | Cropped to an aspect ration of 2:3 from the center. ## Recommendations Recommendations are added under **Recommendations > Add New**. Required fields are the author of the recommended story, primary URL, general URLs, and "one sentence" abbreviation as description on small cards. Large cards use the normal excerpt. Recommendations are meant to be personal promotions of great stories by your fellow authors and to shine light on hidden gems. ### Meta Fields | Field | Type | Explanation | :-- | :-: | :-- | One Sentence * | String | 150 characters or less "elevator pitch" to describe the story. | Author * | String | The author of the recommended story. | Primary URL * | String | Primary link to the recommendation or author’s website. | URLs * | Text | Special formatted list of links to the recommendation, one per line. | Support | Text | Special formatted list of links to support the author, one per line. | Taxonomies (Various) | List | Genres, fandoms, characters, warnings, tags, and categories. | Recommendation Cover Image | Image | Cropped to an aspect ration of 2:3 from the center. ### Example Sentences Think of the sentence as elevator pitch, something you can tell within a few seconds to get the point across. Skip the details, hint at the plot, describe the concept — the story has all the time to tell itself later. Because more often than not, readers will only glimpse at a story while browsing. Recommendations are not prominently featured on _your_ site, after all. > Rebellious corporate heiress and her genius friend commit high-tech heists in a doomed city on the edge of the future. > Schoolgirl gets reincarnated into a fantasy world, though not as heroine but as tentacle monster! > Haunted student discovers her nightmares of gods and horrors from beyond reality are no hallucinations after all. > Girl from the slums discovers her talent for necromancy and learns to love the existential terror she becomes. > Two women forge an unlikely bond and explore the answer to a simple question: is selling your body the same as selling yourself? > Reanimated girls from different epochs roam the ruins of civilizations on the scarred corpse of Earth. ## Pages Pages work the same as always in WordPress, just with some additional fields and template options. [Change the template](https://wordpress.org/support/article/pages/#page-templates) in the settings sidebar, new options being **Chapters**, **Collections**, **Recommendations**, **Bookmarks**, **Bookshelf**, **Bookshelf AJAX**, **Taxonomies**, **No Title Page**, **Stories**, and **User Profile**. You can assign these template pages to certain tasks under **Fictioneer > General > Page Assignments**. * **Chapters:** Shows a list of all visible chapters ordered by publishing date, descending. * **Stories:** Shows a list of all visible stories ordered by publishing date, descending. * **Collections:** Shows a list of all visible collections ordered by publishing date, descending. * **Recommendations:** Shows a list of all visible recommendations ordered by publishing date, descending. * **Bookmarks:** Shows bookmarks without the need for a shortcode. Cache compatible. * **Bookshelf:** Shows paginated lists of an user’s Follows, Reminders, and finished stories. * **Bookshelf AJAX:** Cache compatible version of the Bookshelf, fetching the content after the page has loaded. * **No Title Page:** Default page template but without the heading. Good for a frontpage. * **Taxonomies:** Shows details about all taxonomies used on the site, with count and definition (if provided). * **User Profile:** Frontend account profile to keep users out of the admin. Must never be cached! ### Meta Fields | Field | Type | Explanation | :-- | :-: | :-- | Short Name | String | Shortened name of the page required for custom tabs in stories. | Filter & Search ID | String | Custom identifier to be used with plugin. Does nothing on its own. ## Shared Options These fields and options are available in most post types, which does not mean they make sense everywhere. ### Search Engine Appearance Metadata for search engine results, schema graphs, and social media embeds. If left blank, defaults will be derived from the post content. You can use `{{title}}`, `{{site}}`, and `{{excerpt}}` as placeholders. Titles should not exceed 70 characters but this is not enforced. The Open Graph image is either set manually (click on the box) or defaults to the post thumbnail, parent thumbnail, or site default in that order. Whether these services actually display the offered data is entirely up to them. After all, you could write anything in there.  ### Landscape Image Allows you to choose an alternate featured/cover image that is used for thumbnails which are wider than high, such as with the _showcase_ shortcode. The aspect ratio is between 2:1 and 3:1 depending on the viewport, cropped from the center and fit to cover. Chapters default to their parent story as usual. **Supports:** Posts, Pages, Stories, Chapters, Collections, Recommendations ### Page Layout Allows you to choose an alternate header image instead of the site default and inject custom CSS into the \
, affecting the look of the whole page. Chapters inherit these changes from their parent story or use their own. You can use this to give each story or chapter an individual touch, but be careful with the CSS. **Supports:** Pages, Stories, Chapters, Collections, Recommendations ### Support Links A collection of optional support links: Patreon, Ko-fi, SubscribeStar, PayPal, and a generic donation link for anything else. They are displayed in several places, such as under each chapter unless disabled. You can set different links per chapter and story, defaulting to the parent or author profile if left empty. **Supports:** Posts, Stories, Chapters ### Comments Option to disable commenting on the page. Unlike the "allow comments" option, this will only disable the comment form but still show the current comments. **Supports:** Posts, Pages, Stories, Chapters ### Additional CSS Classes You can add additional CSS classes to paragraphs and other blocks for extra styles and functions. Just select a block in the editor and scroll down to the **Advanced** section in the [block settings](https://wordpress.org/support/article/working-with-blocks/#block-settings) panel. This can be your own or classes provided by the theme, which are highlighted in the editor as shown in the image. You can also apply additional classes to single words or phrases. Switch to the code editor in the options menu (the three dots in the top-right corner) and wrap the desired part like `word`. Make sure to properly close the tag and do not span over multiple blocks unless you know what you are doing, in which case you would not need this guide.  | Class | Effect | :-- | :-- | `sensitive-content` | Hides a block if the **Hide Sensitive Content** chapter formatting option is active. | `sensitive-alternative` | Shows a block if the **Hide Sensitive Content** chapter formatting option is active. | `spoiler` | Blanks out a block (or span) until clicked to be revealed. | `hidden` | Hides a block. Useful for text-to-speech if there is an image or other non-readable element. | `outside-epub` | Hides a block inside ePUBs. Combine with `inside-epub` to have two variants. | `inside-epub` | Hides a block outside ePUBs. Combine with `outside-epub` to have two variants. | `skip-tts` | Blocks with this class will be ignored by the text-to-speech engine. Does not work on spans. | `show-if-bookmarks` | Must be used together with `hidden`, which is removed if bookmark cards are present (via shortcode). | `no-indent` | Suppresses text indentation regardless of settings. | `list` | Applies list styles if missing. | `link` | Applies link styles if missing. | `esc-link` | Prevents link styles from being applied. | `no-wrap` | Prevents whitespaces from being wrapped to the next line. | `full-width` | Forces blocks to be as wide as the space allows. Works well with tables. | `min-480` | Forces blocks to be at least 480px wide regardless of space. Works well with tables. | `min-640` | Forces blocks to be at least 640px wide regardless of space. Works well with tables. | `min-768` | Forces blocks to be at least 768px wide regardless of space. Works well with tables. | `overflow-x` | Adds horizontal scrolling if a block is too wide. Not necessary on tables. | `no-auto-lightbox` | Prevents the lightbox script from being applied if added to an `You can safely use h1
, h2
, h3
, h4
, h5
, h6
, table
, thead
, tbody
, tr
, th
, td
, strong
, b
, u
, s
, em
, br
, ins
, del
, sup
, sub
, hr
, dl
, dt
, dd
, p
, small
, ul
, ol
, and li
.
Strength 5 |
Stamina — |
Agility 5 |
Dexterity 0 |
Fighting 5 |
Intellect 3 ▲1 |
Awareness 4 |
Presence 2 |
Dodge 5 |
Parry 5 |
Fortitude — |
Will 5 |
Toughness 13 |
Experience: 0/200
Mutants & Masterminds OGL Content