1.4.0

1.4.0

Author: chuangcaleb

.changeset/config.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": [
+    "docs"
+  ]
+}

.github/workflows/release.yml

@@ -38,6 +38,8 @@ jobs:
 
       - uses: actions/cache@v3
         name: Setup pnpm cache
+        env:
+          STORE_PATH: ${{ env.STORE_PATH }}
         with:
           path: ${{ env.STORE_PATH }}
           key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}

CHANGELOG.md

@@ -0,0 +1,38 @@
+# obsidian-fountain-editor
+
+## 1.4.0
+
+### Consistent document layout widths
+
+Enforce consistent layout widths by using CSS `ch` instead of ratio widths. (fixes #59)
+
+This ensures consistency in the word wrapping and line breaks between (1) how you see it in Obsidian, and (2) your final rendered PDF.
+
+Of course, that's assuming you don't meddle too much with CSS in Obsidian, as well as standard Fountain-to-PDF settings. This is accomplished by using the `ch` width unit, which ensures consistent width since screenplays use a monospace font. You can be confident in how the
+
+Minor breaking change: if you were previously using the old CSS tokens for widths (e.g. `--fountain--character-left-factor`), they are removed, and instead simplified to just 4 tokens:
+
+```css
+// Current default tokens:
+--fountain-line-width: 60ch;
+--fountain-character-line-width: 16ch;
+--fountain-dialogue-line-width: 38ch;
+--fountain-parenthetical-line-width: 29ch;
+```
+
+This sleeker, cleaner method, unfortunately, becomes funky-looking when on the most popular Obsidian theme. Minimal provides some really cool line-width utilities, which is why I personally use it, but it breaks this.
+
+There is now a toggle in Settings to fix the styling if you are using Minimal theme.
+
+### Markdown Blockquote Annotations
+
+You can now use Markdown blockquotes as screenplay annotations. This is a new more stable alternative to the `%% Obsidian comment %%` annotation -- see [#58](https://github.com/chuangcaleb/obsidian-fountain-editor/pull/58/files). There is also now a setting to opt-out of formatting Fountain forced-Transitions.
+
+Note that if you use Markdown blockquotes, you will need to strip your document of blockquotes before rendering Fountain to PDF.
+
+- 1a75126: Skip processing Obsidian multi-line blockquotes as Fountain forced Transitions
+- a298bc0: Add option to opt-out of formatting Fountain forced-Transitions
+
+### Technical
+
+- 0ce2783: dx: manage versioning with changesets

docs/package.json

@@ -2,6 +2,7 @@
   "name": "docs",
   "type": "module",
   "version": "0.0.1",
+  "private": true,
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",

docs/src/assets/blockquote.png

@@ -6,6 +6,7 @@ banner:
 
 - Boneyard token `*/` is formatted as emphasis/italics by Obsidian. In Live Preview, the `*` the syntax token is hidden.
   - I don't use Boneyards as much, especially now with the `%% Obsidian comment %%` syntax. Low priority.
+- Validated on Default theme. May not work on every theme
 
 ## Roadmap
 

docs/src/assets/synopsis.png

@@ -0,0 +1,38 @@
+---
+title: 🎨 CSS Tokens
+sidebar:
+  order: 5
+---
+
+You can use [Obsidian's CSS snippets](https://help.obsidian.md/snippets) to tweak the styling.
+
+Currently, you can find these defaults at [base.css](https://github.com/chuangcaleb/obsidian-live-fountain/blob/master/src/styles/base.css)
+
+```css
+/* src/styles/base.css */
+
+/* Screenplay font. */
+--fountain-font-family: "Courier Prime", "Courier New", "Courier", monospace;
+
+/*
+* Line widths for each token.
+* Also determines left-right margins.
+*/
+--fountain-line-width: 60ch;
+--fountain-character-line-width: 16ch;
+--fountain-dialogue-line-width: 38ch;
+--fountain-parenthetical-line-width: 29ch;
+
+/* Color of text in %% Obsidian comment %% blocks and <!-- HTML comments --> (not set). */
+/* --fountain-code-comment: */
+```
+
+Technical note: it is recommended to use the CSS `ch` width unit, to ensure consistent layout with industry-standard rendered PDFs of screenplays. This can be achieved since monospace fonts have consistent character widths -- read more at [Sizing Units | web.dev](https://web.dev/learn/css/sizing/#absolute_lengths).
+
+Roadmap plans so far:
+
+- Toggle italics on parenthesis
+- Toggle italics on character extensions
+- Toggle bold on scene headings
+- Toggle bold on transitions
+- Toggle bold on centered text

docs/src/content/docs/contributing/known-issues.md

@@ -1,5 +1,7 @@
 ---
 title: 🖋️ Marking Files for Fountain
+sidebar:
+  order: 1
 ---
 
 There are currently three ways to convert a regular Obsidian note into a hybrid Markdown+Fountain note.

docs/src/content/docs/references/css-tokens.md

@@ -0,0 +1,82 @@
+---
+title: 🙋‍♂️ Opting Out to Markdown
+sidebar:
+  order: 3
+---
+
+When a file is marked for Fountain formatting, the whole file is treated as Fountain, by default. For those who like to annotate in their screenplay, there are a variety of escape-hatch methods to do so.
+
+## Fountain Synopsis
+
+Fountain's [Synopses](https://fountain.io/syntax/#sections-and-synopses) is treated by the processor as a valid line of Fountain, but it does not receiving any additional styling (notably, the custom screenplay font isn't applied).
+
+```md title="Synopsis.fountain.md"
+= Any line that starts with a `=` symbol is treated as a **Fountain Synopsis**.
+```
+
+Technically, it still applies the `cm-fountain-synopsis` class name, but Fountain Synopsis and Headings are excluded from additional Fountain styling.
+
+![demo of using synopsis](/src/assets/synopsis.png)
+
+- Pros:
+  - Valid Fountain syntax, so you don't need any pre-processing to strip it out or whatever.
+- Cons:
+  - Only applied per-line, it gets tiring to type out the `=` prefix on every line. Besides, I don't think multi-line synopsis is the intended use-case for Fountain.
+  - Not supported by Obsidian
+
+---
+
+## Obsidian/Markdown Blockquote (recommended)
+
+Obsidian's [Block/quotes](https://help.obsidian.md/syntax#Quotes) syntax conflicts with Fountain's Forced [Transition](https://fountain.io/syntax/#transition) syntax -- read details at [Syntax Conflicts](/resources/syntax-conflicts/).
+
+However, [if you know how to strip out all the blockquotes before rendering your PDF](/resources/longform), and by [enabling an optional setting](️/references/settings/#-prefer-obsidians-blockquote-over-fountains-forced-transition), you can use liberally blockquotes everywhere!
+
+```md title="Blockquote.fountain.md"
+> Usually, this is Fountain's forced Transition.
+
+> But if there is a non-empty line before or after...
+> Then it is treated like a regular Obsidian-markdown blockquote!
+
+> But you can opt-out entirely with the setting: "Prefer Obsidian's blockquote over Fountain's forced Transition"
+
+> [!important]
+> You can even use callouts!
+```
+
+This is the plugin author's recommended way to annotate screenplays with markdown.
+
+![demo of using blockquote](/src/assets/blockquote.png)
+
+- Pros
+  - Natively supported by Obsidian
+  - Can be converted into Obsidian Callouts!
+  - No rendering issues, CLEAN!
+  - Spans across multiple lines
+- Cons
+  - Requires a step of processing to strip out blockquotes before PDF render
+  - Requires an indented `>` prefix, not flush with document body. However...
+    - Some people sees this clearly defined annotation area, as a win
+    - Native Obsidian support provides that auto-formatting and commands
+
+---
+
+## Obsidian Comments
+
+Text enclosed within `%% Obsidian comment symbols %%` don't receive Fountain formatting, so they look just like regular markdown!
+
+This is no longer the recommended way to annotate screenplay, since we found [an issue](https://github.com/chuangcaleb/obsidian-fountain-editor/pull/58) where a large comment area would break the plugin's Fountain formatting. It is still however a usable way to opt-out into markdown.
+
+```md title="Obsidian Comments.fountain.md"
+%%
+Text inside here will be regular markdown!
+%%
+
+```
+
+- Pros
+  - Natively supported in Obsidian!
+  - Annotations in main body, without additional indentation or markup. Makes it super simple to add new lines.
+  - Spans across multiple liness
+- Cons
+  - Aforementioned issue where large comment blocks causes the plugin's formatting to go whack