farling42 / rwoutput

Tool to convert a Realm Works Output file into other formats.

RWoutput

Tool to convert a Realm Works Output or Export file into other formats.

** NOTE: This tool will NEVER be able to export "protected" content, such as material sold on the Content Market. **

Instructions for Use

1. Within Realm Works, from the "Share" tab of the ribbon select "Manage Exports" and enter some data, then do one of the following depending upon which output you want:

   • For Markdown, select "Full Export". This will generate a file in your "Realm Works\Export" folder whose name ends with ".rwexport".

   • For other formats, select "Compact Output". This will generate a file in your "Realm Works\Output" folder whose name ends with ".rwoutput".

2. Launch the RWoutput tool, press the "LOAD rwoutput FILE" button and select the file created in step 1.

3. If a separate web page is desired for each topic, then ensure that the "Separate Topic Files" option is selected.

4. If you want to restrict the width of images to something more suitable for web pages, then choose the width in the "Max. Width (pixels)" menu. Optionally choose the "apply reveal mask" if your export should hide unrevealed parts of maps.

5. Choose one of the output options:

   • Create HTML file(s) will create XHTML files containing lots of formatting. (Word does not support importing XHTML files, see HTML4 below).

   • Create PDF file - experimental, and might not always work.

   • Print - print the output to a printer, you could choose the "print to PDF" printer on windows 10 for a more reliable PDF output.

   • Create HTML4 file - this is the intermediate file for printing and PDF generation; so why not have it available. This format can also be imported into Word (and possibly other editors).

   • Create Markdown - which will prompt you for a directory into which the markdown files will be placed.

rwoutput's Issues

Add caption to each picture

Each picture should be titled (or subtitled).

Show child topics at end of each topic page

Where a topic has some child topics, the HTML section/page for the parent topic should end with a "Contents" section which lists the child topics.

Request: Preffix Suffix Tag Option

An option to enable either a Preffix/Suffix as a tag would be fantastic. Perhaps as a on/off choice?
LWD required all Mechanics to have a suffix code to match the content. So this would be a great place to pull a tag from.

MD: Improved table formatting using Obsidian Table-Extended plugin

The obsidian plug-in called "Table Extended" uses the MultiMarkdownTable syntax defined at https://fletcher.github.io/MultiMarkdown-6/syntax/tables.html

The Obsidian.md plugin is available from https://github.com/aidenlx/table-extended

MD: Keep accented characters in tag names

Order main page by category

The main index page of a multi-page output should be ordered by category.

MD: convert tables to markdown

Some tables are still in HTML, these need to be converted to markdown.

Request: Ability to resize images on import

I'm not sure I completely understand the format you are using for linking images yet however there is capability to set image sizes using something like:

![[Image.png|200]]

Where 200 could be a variable fed in via the Output Formatter?

MD: Fix presentation of annotations

Annotations need to be separated from the rest of the snippet by "; " and displayed in italics.

Add Prefix and/or Suffix to topic titles

Allow prefix and/or suffix to be added to topic titles

And alternative names?

MD: add option to have navigation at top of page

MD: add base name of topic as ALIAS for linking purposes.

Since all notes are created as FULL names, create an alias in the frontmatter that will allow the BASE NAME to be used for linking.

(only needs adding if there is a suffix and/or prefix)

Feedback - Text Formatting

Morning,
Starting to really slow down and look at the output in detail. Not sure if there's anything that can be done about this. I've noticed over the years that the way text works in RW is rather odd (it cold also just be me, who knows) and it tends to add spaces in where they don't belong. This seems to be having an impacted on the output.

Between paragraphs theres usually an empty line. If that line is clean, then the output format is fantastic.
However in some situations there's spaces on the empty lines. Where that occurs the output format has a large gap between the paragraphs.

Here's an example:

And as you can see. The reason for the gap is there a spaces on the empty line.

So yeah. Not sure if anything can be done. I see this as an issue with the source realm but FYI.

Output to Fantasy Grounds

Have an option to generate a Fantasy Grounds module from the RWoutput file.

See the following pages:
https://www.fantasygrounds.com/wiki/index.php/Developer_Guides
https://www.fantasygrounds.com/wiki/index.php/Campaign_and_Module_Data_File_Overview
https://www.fantasygrounds.com/wiki/index.php/Developer_Guide_-_Modules_-_Overview
D:\ProgramData\Fantasy Grounds\modules\AAW-BASIC-1-PF.mod\

Create mermaid tree for each relationship.

A mermaid relationship tree needs to go into its own note, which can then be linked to by each referenced topic note.

Each type of relationship should build a tree of all connected nodes.

Some connection types don't really work for building a tree - such as arbitrary.

```mermaid
graph TD
topic_1(Eye of Abendego)
topic_2(Onokin)
topic_42(Ungoro Tedar)

topic_1 -- Master to Minion --> topic_2
topic_42 --> topic_1
```

Feedback - Heading Formatting

I suspect this could be because the raw text is a whole paragraph of BOLD.

Looks like the heading got confused about where it should start/end.

Pattern seems to be where there is a line of BOLD is does weird things.

Interestingly... that link does not exist in RW. I do wonder if it was linked once upon a time and I removed it though.

Fill in HTML head element

Copy the "definition" section of the RWoutput into the HTML head element (of each page?).

Put contents list on left side of page

With multiple pages available, display the contents list on the left of the page, and the currently selected topic on the right side of the page.

Request - MetaData For Tags

Is it possible to get the tags added to the Meta Data?

Example: A spell is used by a Bard and it's an Transmutation Spell.

---
ImportedOn: Sunday, 12 December 2021 9:55:01 PM
Tags: Category/Spell
Class: Bard
School: Transmutation 
parent:
  - 9. - Spell Descriptions
up:
  - 9. - Spell Descriptions
prev:
  - Zone of Truth
RWtopicId: Topic_425
---

This will enable the use of Dataview. For example:

```dataview
table ImportedOn, Class, School
where (School = "Transmutation")

This then updates automatically to: 

![image](https://user-images.githubusercontent.com/8046697/145711048-06a3072b-5bb9-49d1-849e-f51d98c6448b.png)

This could be really powerful. 

MD: sometimes links are missing letters

Support additional snippet types

The following are complete (but might need extra CSS styles)
Labeled_Text = done
Multi_Line = done
Numeric = done
Date_Game = done
Date_Range = done
Tag_Standard = done
Tag_Multi_Domain = done
Picture = done
Smart_Image = done (including reveal mask and map pins)

The following are saved as external files are linked inside topic page
Statblock = done
Portfolio = done
Rich_Text = done
PDF = done
Audio = done
Video = done
Foreign = done
HTML = done

The following are not done:
Hybrid_Tag = not done

Use correct file header for HTML5/XML

use content-type = application/xhtml+xml
no DOCTYPE tag at start

Provide all external objects inline instead of as separate files.

Find a way to inline external objects instead of saving them as separate files.

HTML: Multi-column output

http://forums.wolflair.com/showpost.php?p=287361&postcount=115

Well, I tried playing with the css but my experience with css equals zero, so all I managed to change was the fonts and their formatting. Tried to add columns and padding and failed at both. Didn't spend fore than 2h max on it though.
My idea was to make it look more like the page of an official rulebook or supplement.

Request - Rename the Asset Folder to z_asset-files

Just so that the asset folder goes to the bottom of the sort queue.

Collapse/Expand all index entries

Provide a simple way of expanding/collapsing ALL the entries in the index via a single button.

HTML: Multi-coloured map pins

Have the map-pins for smart maps be selected from a group based on the type of article to which it is linked.

MD: put in flag for dice rolling

The Obsidian.md plug-in called "Dice Roller" (https://github.com/valentine195/obsidian-dice-roller) requires dice rolls to be entered in any of the formats

`dice: 1d2`
`dice: 3d4 + 3`
`dice: 1d12 + 1d10 + 5`
`dice: 3d4+3d4-(3d4 * 1d4) - 2^1d7`

MD: generate text strings instead of font direct to stream

Creating strings in write_para will allow me to strip off paragraph markings on annotations (and other improvements from foundry module)

Generate a long list of CSS dynamically

While loading each topic, look for individual "style" attributes on any element.
Store those "style" attributes in a lookup table - and replace the "style" attribute with a "class" attribute indicating the name added to the lookup table.

Lots of styles in the RWoutput file are the same across many elements, so this should further reduce the overall file sizes.

PDF and Printing

Qt provides the QPDFWriter and QPrinter devices which provide a paint device on which QTextDocument can be drawn, assuming that the XML has been converted into the Qt subset of HTML4.

Better linking between pages.

There should be a "HOME" button on each topic page.

There should be a list of "child" topics on each topic page: Maybe in a new section at the end of each file.

Add a footnote to each page containing the generation time of the page.

Add footer to each page

Provide a footer which provides a link back to the main index.

MD: Remove center from page title

Fill in correct head/meta elements

author = me?
generator = RWoutput + version

Index file not generated

A user reported that he did not get an index file generated.

See http://forums.wolflair.com/showpost.php?p=267287&postcount=62

MD: Add connections to markdown

Process the connection elements in each topic.

Create explicit line at end of each page showing links out to other pages.

Add tag of some sort to allow connection to be shown by other diagrams/graphs.

Add GUI option for user to choose his own CSS file

Advanced users might want to use their own CSS file.
Provide an option to use their own CSS instead of the standard CSS that we would install.

Smart Map support

Add map pin data to the exported data.
The simple (?) thing is to create the link map.
The difficult thing is to create the overlay of map pins.

MD: Create placeholder notes for each user category

Display alternative names

The "true name" and the other alternative names need to be made available in the HTML output.

Parse embedded HTML properly

The current HTML parsing doesn't work properly, since HTML isn't well-formed XML.

Some tables start each row with but don't have the ending token.

MD: check frontmatter required by other folder plugins

Convert map pins into HTML Links

map_pin elements are created on a smart_image.
These need converting into HTML links to get to the relevant topics.

Handle MASSIVE files

When reading in a 900 MB file, the program runs out of memory (being a 32-bit app).

It needs to read one topic (hierarchy) at a time, and then output that one topic.

MD category tags ships be preceded with "category/name"

HTML: Allow formatted tooltips in generated HTML

Using jquery-ui, the tooltip's "title" attributes are still used.
Only need to add an "include" of the script in the head of each page.

See https://jqueryui.com/tooltip/

Presumably have a single output configuration option to put the extra line(s) in the header, and to generate full HTML inside the 'title' instead of just basic text.

Here are the images we're using

Fetch HTML stat block out of Hero Lab portfolio files.

Provide for the display of hero lab stat blocks inline by extracting from the HL portfolio file.

Export to FTP web site

After generating HTML, automatically export the files to a web site (via FTP).