Overview

Journal Entries provide a method for GMs to present and maintain hand-outs for their players. Entries are edited using a rich text editor (with HTML support gated behind a convenient 'source' button in the editor). Journal entries can be displayed to all players at the touch of a button, and conveniently "pinned" to the grid in any scene to allow for quick access to that entry.

This article will familiarise you with creating and editing journal entries, changing their views, adjusting their permission levels, and creating dynamic links to entities.

The Journal Entries Directory

Journals - Directory
The Journals Directory contains your world's collected journal entries.

Journal entries are created and managed from the Journal Entries sidebar.

Like the Scenes, Actors, and Items Directories, this directory can contain folders to organize your world's Journal Entries. To organize journals into folders, you can click and drag the journals directly, or when editing the journal entry, you can select the folder it belongs to. You can click on folders to expand them, showing all of the contained journal entries, or click an expanded folder to collapse it, hiding the contained journal entries. 

Only a Gamemaster or Assistant-level user can change or move folders themselves, but any players with at least Limited permissions for a Journal Entry can see it and the folder containing it.

As with all other entity directories, the "quill" icon on a Journal Entry folder will create a new journal entry inside that folder, and the "plus folder" icon will create a new subfolder.

Creating Map Notes from Journal Entries

A Journal Entry can be 'pinned' to any scene, generating a Map Note that connects to that Journal Entry simply by dragging the entry from the sidebar to the location you would like to place a Map Note. The visibility of these map notes is based on the entry's configured permissions, which are discussed later in this article.

For a greater explanation of this feature, and how it can be used you can also refer to the Map Notes article.

Creating Journal Entries

To create a new journal entry, click the Create Entry, this will open a dialog where you'll name the entry. If you have created folders in your journals directory, you can select the folder it should be placed in, if you like.

Once you've named the journal entry and clicked Create New Journal Entry you'll be presented with the blank edit window for that entry.

From this point you can begin filling it out as you see fit!

The Journal Editor

A Journal Entry
An example Journal Entry in Text mode.

Journal Entries may have both a Text View and an Image View, which can be switched between by clicking the "Text" or "Image" buttons on the top menu of the Journal Entry.

Text View is the default mode of all newly created journal entries, and includes the text editor. The GM or Owner can make numerous changes to the way the text is formatted using the menus at the head of the editor while in editing mode. 

Image View mode provides the GM or Owner to select an image using the Filepicker, and places the selected image in a shadow box.  A journal entry that has an image and no text will automatically open in image view.

Secret Text

Foundry adds a custom formatting called Secret to text entries which will only be visible to the GM or Owner of the Journal Entry. You can create a Secret by selecting "Custom" and then "Secret" from the Paragraph formatting menu. If text is selected when you choose 'secret' it will change the selected text to Secret.

Journal Source Code

In addition to the formatting option available through TinyMCE, using the "Source Code" option from the formatting menu will allow you to edit the HTML of the journal entry directly, opening access to HTML tags and a vast array of custom styling.

Linking Entities

The editor allows you to link to other types of entities in the rich text editor, including actors, item, journal entries, rollable tables and scenes. For more information on this, consult the Dynamic Entity Links section later in this article.

Showing Journal Entries to Players

Journal entries may be shown to all players regardless of their permission to access the journal, simply click "Show Players" from the heading menu for any Journal Entry.

Clicking the Show Players button while in Text View will show all players with sufficient permissions the text content of the journal entry.

Clicking the Show Players button while in Image View will show all players with sufficient permissions the selected image.

Journal Context Menu Options

Journals - Context Menu
The context menu provides a selection of useful actions related to manipulating existing journals.

You can right click any journal entry in the journals directory to open the context menu. This menu provides a list of useful actions that allow you to manipulate the chosen entry in various ways. The specific options are as follows:

Clear Folder
Removes the Journal Entry from all folders, placing it at the top level of the Journal Entries directory.
Delete
Deletes the Journal Entry, after accepting a confirmation prompt.
Duplicate
Creates a copy of the Journal Entry in the directory.
Configure Permission
Configure the permission levels of the Journal Entry, allowing players of your choice to view or modify the Journal Entry in the directory.
Export Data
Exports the Journal Entry's data as a JSON file on your computer.
Import Data
Imports data into the Journal Entry from a JSON file on your computer.

Journal Permission Levels

As with all other Entities, Journal Entries have levels of Permissions that when assigned allow them to view and edit those entries at differing levels. The levels of permission are:

None (default for non-creator)
The user has no permission to view or edit a Journal Entry by default.
Limited
The user may see the map pin for this Journal Entry but will not see it in the sidebar. Double-clicking the map note pin will allow the Journal Entry Image to be displayed, but not the text.
Observer
The user may see the map pin for this Journal Entry as well as the Journal Entry in the sidebar, and may open the actual journal by clicking on the pin or its entry in the sidebar. In addition, the user may toggle between Image view and Text view for that journal entry.
Owner (default for creator)
The user may see the map pin and sidebar entry for this journal, and when the window is open may edit and change any features of that Journal Entry.

Though not exclusive to Journal Entries, Foundry supports linking to other types of Entities from within its rich text editor system. Actors, Items, Journal Entries, and Rollable Tables may be linked to dynamically by dragging and dropping an entity from the sidebar into an open editor.

The syntax to create a dynamic link is as follows:

@EntityType[Entity Name]
@EntityType[Entity ID]{Custom Text}

For example:

@Actor[Locke]
@Actor[Pt1jPTgVWdJ6QYIA]{Locke}

This allows a GM to quickly link numerous journal entries to one another and, if the user viewing the Journal Entry has permission to view the linked entity, clicking on the link will open the linked entity in another sub-window of Foundry.

Dragging and Dropping Entities

In addition to the above method, you can drag and drop any actor, item, scene roll table or other journal entry into an open journal entry that's being edited. This will create a link to the item in question, which can be clicked to open when the journal entry is being viewed in its saved form. This is useful for creating hub entries that can help direct readers to other articles or reference other aspects of the game world. Readers may need specific permissions for the entity links, however, or else the items in question won't be fully visible to them. 

Scene Notes

Scenes may be configured to provide easy access to a Journal Entry containing notes for that scene for the GM's convenient reference. To do so, from the scene configuration menu choose the Journal Entry you wish to associate with your scene from the Journal Notes dropdown menu.

These notes can be accessed quickly by right clicking the Scene Name in the Navigation Menu and choosing "Scene Notes."

API References

To interact with Journal Entry entities programmatically, you will primarily use the following API concepts: