Merge pull request #1528 from klembot/develop

2.9.0

.github/workflows/prettify-prs.yml

@@ -0,0 +1,24 @@
+name: Prettify PRs
+
+on:
+  pull_request:
+    branches: [develop]
+  workflow_dispatch:
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+          # Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
+          persist-credentials: false
+      - name: Prettify code
+        uses: creyD/[email protected]
+        with:
+          commit_message: Prettify code
+          only_changed: true

.prettierignore

@@ -0,0 +1 @@
+public/story-formats

docs/en/src/SUMMARY.md

@@ -63,6 +63,7 @@
   - [If Your Story Is Damaged](troubleshooting/damaged-story.md)
   - [If You See Visual Glitches in Twine](troubleshooting/visual-glitches.md)
 - [Release Notes](release-notes/index.md)
+  - [2.9 versions](release-notes/2-9.md)
   - [2.8 Versions](release-notes/2-8.md)
   - [2.7 Versions](release-notes/2-7.md)
   - [2.6 Versions](release-notes/2-6.md)

docs/en/src/getting-started/installing.md

@@ -36,6 +36,12 @@ site data."
 Keeping backups regularly is a must if you use browser Twine. See [Archiving and
 Exporting Stories](../story-library/exporting.md) for how to do this.
 
+Browser Twine can be installed as a progressive web application (PWA). For
+information on how to do this, please check your browser's documentation. Using
+Twine as a PWA means that it will be available even when you don't have an
+network connection, but you should still keep regular backups, as PWAs are still
+subject to having their data being erased when clearing browsing data.
+
 ### iOS Browsers
 
 **If you want to use Twine on iOS, you must [add it your Home

docs/en/src/publishing/publishing.md

@@ -10,7 +10,12 @@ You can publish a story from both the _Story Library_ and _Story Map_ screens.
   tab.
 
 Twine will then ask you to choose a file name and location to save your
-published file.
+published file. The file name you choose doesn't affect the name of your story
+in its published form. In other words, if you publish a story named "My Best
+Story" in your library to a file named `my-worst-story.html`, the story will
+still show its title as "My Best Story" in a web browser. If you'd like to
+change the name of your story in its published form, [rename
+it](../editing-stories/renaming.html) before publishing.
 
 Some versions of the Safari web browser may instead open a browser tab with an
 address that begins with `blob://`. If this happens, choose _Save As_ from

docs/en/src/release-notes/2-9.md

@@ -0,0 +1,28 @@
+# 2.9 versions
+
+## 2.9.0
+
+Release Date: June 16, 2024
+
+## New Features Added
+
+- Browser Twine can now be installed as a progressive web application (PWA).
+  This is an early feature and bugs may exist with it. Please bear in mind that
+  although PWAs allow for use offline, backups are still important to keep, as
+  their data may be deleted when clearing browsing data.
+- A `data-tag` attribute is added to passage cards in the story map, which can
+  be targeted using custom CSS. It otherwise doesn't have any effect in the
+  story map.
+
+## Bugs Fixed
+
+- The story library now sorts correctly by date.
+- An error in the Italian localization has been fixed.
+
+
+## Story Format Updates
+
+- Chapbook has been updated to version
+  [2.1.0](https://klembot.github.io/chapbook/guide/references/version-history.html#210-16-june-2024).
+- Harlowe has been updated to version
+  [3.3.9](https://twine2.neocities.org/#changes_3.3.8-changes-(jan-03,-2024)).

docs/en/src/troubleshooting/wont-start.md

@@ -1,5 +1,7 @@
 # If Twine Won't Start
 
+This page only applies to app Twine.
+
 If Twine shows an error message when first starting and immediately quits, it's
 most likely because it is having trouble loading either your preferences or
 stories. Twine tries its best to repair problems it finds in saved files at
@@ -13,6 +15,44 @@ There are a few steps you can take that may fix this problem:
    when you add back a story, that story is the source of the problem.
 3. Reinstall Twine.
 
+## Getting More Detail on Startup Problems
+
+Twine logs information as it starts up and works that is not normally visible.
+If you're having problems, though, these logs might tell you more about the
+source of the problem. To see them, you'll need to start Twine from the command
+line. Once you've started Twine from the command line, you'll see Twine's logs
+in that window.
+
+### Linux
+
+How to do this depends on the distribution of Linux you use. In a desktop
+environment, you will need to start a terminal session. Gnome and KDE have apps
+(called "Gnome Terminal" and "Konsole") to do this.
+
+Once you've started a terminal session, you'll need to run Twine from wherever
+it was installed. Unfortunately, this varies by distribution as well.
+
+### MacOS
+
+Open your Applications folder, then the Utilities folder. Open Terminal in this
+folder, then type the following into the window that appears and press the Enter
+key:
+
+`/Applications/Twine.app/Contents/MacOS/Twine`
+
+### Windows
+
+Open the Start menu, then run the Command Prompt application. This will open a
+window. After it's opened, open the Start menu again and locate Twine, but
+right-click on it instead of opening the entry. Choose the _Open file location_
+option from the context menu. This will open a folder containing the Twine icon.
+Right-click this icon and choose _Copy as path_ from the context menu.
+
+Finally, go back to the Command Prompt window and right-click inside the window.
+This will paste the location of Twine into the window. If you've copied the path
+correctly, what you have pasted should end with `Twine.exe`. Don't edit what was
+pasted; only press the Enter key to launch Twine.
+
 ## Resetting Preferences in Browser Twine
 
 To reset your preferences, you'll need to [edit your browser local

index.html

@@ -5,6 +5,7 @@
 		<meta name="viewport" content="width=device-width, initial-scale=1" />
 		<meta name="theme-color" content="#000000" />
 		<title>Twine</title>
+		<link rel="icon" href="icons/favicon.svg" type="image/svg+xml">
 	</head>
 	<body>
 		<noscript>You need to enable JavaScript to run this app.</noscript>

jest.config.js

@@ -11,6 +11,6 @@ module.exports = {
 	roots: ['<rootDir>/src'],
 	setupFilesAfterEnv: ['<rootDir>/src/setupTests.ts'],
 	testEnvironment: 'jest-environment-jsdom',
-	// segseg is an ESM-only module.
-	transformIgnorePatterns: ['node_modules/(?!(segseg)/)']
+	// segseg is a ESM-only module.
+	transformIgnorePatterns: ['node_modules/(?!segseg)']
 };