Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various fixes to documentation #1448

Merged
merged 3 commits into from
Sep 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ In order to use Twine most effectively, you should spend some time reading the d
- [Snowman](https://videlais.github.io/snowman/2/)
- [SugarCube](http://www.motoslave.net/sugarcube/2/)

You might also find the [Twine Cookbook](https://twinery.org/cookbook) useful to read. It contains example code and explanations for things Twine authors often want to do.
You might also find the [Twine Cookbook](https://twinery.org/cookbook) useful to read. It contains example code and explanations for things Twine authors often want to do.
2 changes: 1 addition & 1 deletion docs/en/src/customizing/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ features.
Here's a sample `user.css` that replaces the graph paper background of the story
map with a plain gray color:

```
```css
.passage-map {
background: hsl(0, 0%, 75%) !important;
}
Expand Down
2 changes: 1 addition & 1 deletion docs/en/src/customizing/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Customizing Twine

This section describes how you can customize Twine to fit your needs.
This section describes how you can customize Twine to fit your needs.
2 changes: 1 addition & 1 deletion docs/en/src/customizing/preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ and JavaScript edit dialogs.)
- The _Custom_ font setting allows you to specify any font that's installed in
your computer. You _must_ spell this font name exactly right, including any
spaces or other symbols in the font name. Capitalization doesn't matter when
setting a custom font.
setting a custom font.
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/changing-story-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ tab. There's a menu in the dialog that opens that allows you to set a different
format.

Story formats must be [installed in Twine](../story-formats/adding.md) before
they appear in this menu.
they appear in this menu.
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/deleting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ shortcut.

Deleting passages can be undone using [the buttons in the corner of the top
toolbar](undoing.md). (So can almost all actions in the Story Map screen, but
because deleting stories is permanent, it's worth calling out here.)
because deleting stories is permanent, it's worth calling out here.)
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/editing-passages.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ are true:
- It is linked to from another passage
- It has any tags
- It has a different size than the default
- It is the story start
- It is the story start

## Text Formatting, Code, Images, Sound, Video... Basically Everything Cool

Expand Down
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/finding-replacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ has a good introduction to the topic.
If you use regular expressions in your search, the _Replace_ field can also
contain backreferences. For example, if you enter `(.)and` in the _Find_ field
and `$1---` in the _Replace_ field, the text `Sand band` will be replaced to
`S--- b---`.
`S--- b---`.
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

When you edit a story from the Story Library screen, it will take you to a view
of the story called the Story Map screen. You'll probably spend most of your
time in Twine here.
time in Twine here.
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/linking-passages.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ that use story format-specific functionality, like code.
It's possible to use more than plain text as the trigger for a link, but how
this works is dependent on the story format you are using. It's often possible,
for example, to enter an HTML `<img>` tag in the label part of a link. But this
may or may not be supported by the story format you are using.
may or may not be supported by the story format you are using.
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/navigating.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ text field.
This will open a dialog with a search field. Enter either the name of a passage
or some text it contains, and a list of matching passages will appear. Twine
uses fuzzy matching, so you don't have to enter the passage name exactly, and it
will find close matches if you make a typo. When deciding which pasages match
will find close matches if you make a typo. When deciding which passages match
what you've typed, it slightly prefers matches in a passage name to what's in
passage text.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/renaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ top toolbar. The only restriction on story names is that they must be unique
among your library.

You can also rename a story [in the _Story Library_
screen](../story-library/renaming.md).
screen](../story-library/renaming.md).
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/selecting.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ each story in your library, so one story can use grid snapping while another
doesn't.

Grid snapping only affects passage cards when you move them. It doesn't affect
the existing position of cards.
the existing position of cards.
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ _Story_ top toolbar tab. This shows:

IFIDs are akin to ISBNs for books. They help catalog Twine stories alongside
other forms of interactive fiction. You can learn more about IFIDs at [the
Interactive Fiction Database](https://ifdb.org/help-ifid).
Interactive Fiction Database](https://ifdb.org/help-ifid).
2 changes: 1 addition & 1 deletion docs/en/src/editing-stories/undoing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ When you leave the Story Map screen, either going to a different screen in Twine
or closing the application entirely, your undo history is discarded.

If the undo or redo button is disabled, that's because there's nothing to undo
or redo yet.
or redo yet.
2 changes: 1 addition & 1 deletion docs/en/src/getting-started/basic-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ for others.

Twine includes four story formats when you download it, and it is possible to
[add other story formats](../story-formats/adding.md) that people in the
community have made.
community have made.

- [**Chapbook**](https://klembot.github.io/chapbook/) is the youngest story
format. It's designed to be easy to learn and to make many common tasks people
Expand Down
2 changes: 1 addition & 1 deletion docs/en/src/getting-started/downgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ uses.

You may also need to [reset your preferences](../troubleshooting/wont-start.md).
Although the instructions linked are for the most recent version of Twine, they
will probably work with most older versions of Twine as well.
will probably work with most older versions of Twine as well.
2 changes: 1 addition & 1 deletion docs/en/src/getting-started/getting-around.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ Dialog boxes have a few controls in their title bar:

You can have as many dialogs open as you have room onscreen for. Right now, the
order of dialogs can't be changed, nor can their position onscreen be changed.
The width of dialogs can be changed in [preferences](../preferences).
The width of dialogs can be changed in [preferences](../preferences).
2 changes: 1 addition & 1 deletion docs/en/src/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Getting Started

This section describes Twine from the ground up: how to start using it and basic
concepts that are key to understanding how it works.
concepts that are key to understanding how it works.
2 changes: 1 addition & 1 deletion docs/en/src/getting-started/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ your platform (Linux, macOS, or Windows).
Directly](../troubleshooting/local-storage.md). Local storage is similar to
browser cookies, which you might be more familiar with, but cookies are
limited to 4 KB of storage, whereas local storage can hold megabytes of data
(the exact number is dependent on the browser).
(the exact number is dependent on the browser).
2 changes: 1 addition & 1 deletion docs/en/src/getting-started/uninstalling.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ you're using.
to uninstall it.
- On macOS, delete the Twine app from your Applications folder.
- On Windows, right-click the Twine entry in your Start menu and choose
_Uninstall_.
_Uninstall_.
8 changes: 4 additions & 4 deletions docs/en/src/getting-started/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Browser Twine

Browser Twine is updated whenver there's a new release, so there's no work for
Browser Twine is updated when there's a new release, so there's no work for
you to do to stay up-to-date. If you need to use an older version, go to
https://twinery.org/[version number]. That is, to use 2.3.13, go to
https://twinery.org/2.3.13. These different versions will use the same story
`https://twinery.org/[version number]`. That is, to use 2.3.13, go to
`https://twinery.org/2.3.13`. These different versions will use the same story
library and preferences.

Keep in mind, though, that earlier versions will have bugs the most recent
Expand All @@ -18,4 +18,4 @@ To check if a newer version of Twine is available, choose _Check for Updates_
from the menu named _Twine_ in the menu bar (not the top toolbar). Twine will
tell you if there's an update available and, if you like, will direct you to
where to go to download the new version. Twine doesn't automatically update
itself.
itself.
2 changes: 1 addition & 1 deletion docs/en/src/limitations/collaborating.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ If you're using app Twine, using cloud storage services like Dropbox or Google
Drive to sync your story library is not recommended. It is very easy for these
services to get confused as to the state of your story files--they often try to
merge changes from different sources together on your behalf--and cause your
stories to become corrupted.
stories to become corrupted.
2 changes: 1 addition & 1 deletion docs/en/src/limitations/combining.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ files, using a notation called
If you want to have multiple, separate story files that communicate with each
other in some way--say, for an episodic game--then how you might do that is
specific to the story format you are using, so check its documentation for
details.
details.
2 changes: 1 addition & 1 deletion docs/en/src/limitations/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Limitations

Twine, like any piece of software, isn't perfect. In this section, some
limitations of Twine are described as well as possible ways to work around them.
limitations of Twine are described as well as possible ways to work around them.
4 changes: 2 additions & 2 deletions docs/en/src/limitations/large-stories.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ number of passages, amount of text, or number of links.

If you're using browser Twine, you are limited by the amount of storage space
your browser allows Twine. You can see the amount of space available as a
percentage in the corner of the Story Library screen.
percentage in the corner of the Story Library screen.

If you're using app Twine, you're limited by the amount of space on your
computer, but you're very unlikely to be limited by this in practice.
Expand All @@ -18,4 +18,4 @@ more. As a result, it's hard to advise specific actions if you notice that Twine
is sluggish with your story.

One possibility, though, is to [split your story](./combining.md) into multiple
stories.
stories.
2 changes: 1 addition & 1 deletion docs/en/src/limitations/multimedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ preview it with the multimedia files.
It is possible to use [Base64
encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs)
to embed multimedia directly into a Twine story, but this isn't recommended as
it is difficult to work with and will make your stories much larger in size.
it is difficult to work with and will make your stories much larger in size.
2 changes: 1 addition & 1 deletion docs/en/src/limitations/source-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ stories difficult. Converting your stories to the plain-text Twee format before
checking them into a source code repository can help with this. Command-line
tools like [Tweego](https://www.motoslave.net/tweego/),
[Extwee](https://github.com/videlais/extwee), and
[twine-utils](https://www.npmjs.com/package/twine-utils) can do this for you.
[twine-utils](https://www.npmjs.com/package/twine-utils) can do this for you.
2 changes: 1 addition & 1 deletion docs/en/src/publishing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Although it is possible to play a story from inside Twine, most of the time
you'll want to publish it in a standalone form. This section describes how to
prepare a story so that it can be shared with a broader audience.
prepare a story so that it can be shared with a broader audience.
2 changes: 1 addition & 1 deletion docs/en/src/publishing/playing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ You can play a story from both the Story Library and Story Map screens.
The address you see in your web browser while playing a game launched from Twine
will only work for you and your computer. It will not work for other people. To
share your story with other people, you will need to [publish
it](publishing.md).
it](publishing.md).
2 changes: 1 addition & 1 deletion docs/en/src/publishing/proofing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ story from both the Story Library and Story Map screens.
- In the Story Map screen, choose _Proof_ from the _Build_ top toolbar tab.

The story format that's used for proofing is [set in Twine's Story Format
screen](../story-formats).
screen](../story-formats).
2 changes: 1 addition & 1 deletion docs/en/src/publishing/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ only be downloaded by viewers, not directly played in a brwoser.
Two services that offer Twine-specific hosting are
[Borogove](https://borogove.app) and [Itch.io](https://itch.io). Itch is more of
a marketplace, while Borogove is more closely aligned with the interactive
fiction community.
fiction community.
2 changes: 1 addition & 1 deletion docs/en/src/publishing/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ your story's start passage, your story may not behave correctly if you test from
a later point.

You can only test from a specific passage in the Story Map screen. Select a
passage card, then choose _Test From Here_ from the _Passage_ top toolbar tab.
passage card, then choose _Test From Here_ from the _Passage_ top toolbar tab.
2 changes: 1 addition & 1 deletion docs/en/src/story-formats/adding.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ load the story format from the address you've entered, it will show a preview of
the format name and version you're adding. Choose _Add_ in the dialog to add it.
It'll appear in the list of story format cards immediately. You can now either
[set it as the default story format](default.md) or [change individual
stories](../editing-stories/changing-story-format.md) to use it, if you like.
stories](../editing-stories/changing-story-format.md) to use it, if you like.
1 change: 0 additions & 1 deletion docs/en/src/story-formats/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ Changing the default story format doesn't affect stories you've already created,
only new ones you create in the future. You [can change the story format for
existing stories](../editing-stories/changing-story-format.md) in the Story Map
screen.

2 changes: 1 addition & 1 deletion docs/en/src/story-formats/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Although Twine comes with several story formats, it's also possible to add
others that people have published themselves, and to customize which format
you'd like to use for new projects.
you'd like to use for new projects.
2 changes: 1 addition & 1 deletion docs/en/src/story-formats/proofing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ for Proofing" sticker will appear on the card to confirm the change. If the _Use
to Proof Stories_ button is disabled, the format you've selected is already the
proofing format, or the format you've selected is not a proofing format. (In
that case, you probably want to [set it as your default format](default.md)
instead.)
instead.)
2 changes: 1 addition & 1 deletion docs/en/src/story-formats/removing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ proofing story format.
If a story uses a story format you've removed, you'll need to [change it to
another format](../editing-stories/changing-story-format.md). Twine will also
notice this problem the next time you start it and repair your story so that it
uses the closest story format version available.
uses the closest story format version available.
2 changes: 1 addition & 1 deletion docs/en/src/story-formats/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ either by opening the application or visiting the online version.

Twine does both of these things to lessen the impact of story format updates, so
that as upgrades are available, you don't need to take any action to be
up-to-date. It's not possible to change or override this behavior.
up-to-date. It's not possible to change or override this behavior.
2 changes: 1 addition & 1 deletion docs/en/src/story-formats/viewing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ To view only story formats you've added yourself, choose _User-Added Story
Formats_ from the _View_ top toolbar tab.

To view all formats, including older versions of story formats, choose _All
Story Formats_ from the _View_ top toolbar tab.
Story Formats_ from the _View_ top toolbar tab.
2 changes: 1 addition & 1 deletion docs/en/src/story-library/deleting.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ In app Twine, deleted story files are moved to your trash can or recycling bin
on macOS and Windows. (On Linux, Twine does its best to move the story to the
trash, but what exactly it does depends on your desktop environment). If you
change your mind about deleting a story, you can take it out of the trash or
recycling bin and [re-import the story file](creating.md).
recycling bin and [re-import the story file](creating.md).
2 changes: 1 addition & 1 deletion docs/en/src/story-library/editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ browser, you can open Twine in multiple tabs and edit a different story in each
one, but editing the same story in multiple tabs will almost certainly cause
problems. Browsers isolate tabs from each other for security, which means that
Twine in one tab can easily overwrite changes made in a second tab on the same
story.
story.
2 changes: 1 addition & 1 deletion docs/en/src/story-library/exporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ this file.

Twine creates Twee files with a `.twee` file suffix. Your system may not know
how to handle them by default, but they are openable in any plain text editor,
like Notepad on Windows or TextEdit on macOS.
like Notepad on Windows or TextEdit on macOS.
2 changes: 1 addition & 1 deletion docs/en/src/story-library/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Using the Story Library

When you first open Twine, it'll show you the Story Library screen. This screen lets you create new stories, organize them, and begin working on them.
When you first open Twine, it'll show you the Story Library screen. This screen lets you create new stories, organize them, and begin working on them.
2 changes: 1 addition & 1 deletion docs/en/src/story-library/renaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ To rename a story, select it and choose _Rename_ from the _Story_ top toolbar
tab. Twine will prevent you from choosing the same name as another story in your
library.

You can also rename a story [while editing it](../editing-stories/renaming.md).
You can also rename a story [while editing it](../editing-stories/renaming.md).
2 changes: 1 addition & 1 deletion docs/en/src/story-library/viewing.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ stories yet.
[^preview-color]: The color of your story preview is more-or-less randomly
governed by your story's name. There isn't a significance to the
colors--they're just there to help you find a particular story faster, and
to look pretty.
to look pretty.
2 changes: 1 addition & 1 deletion docs/en/src/troubleshooting/backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ In these directories, look for files ending in `.html`. They will not have your
story name in their title, though. Instead, they have a long string of random
characters, like `7fd8be91-a6d1-459a-a955-b8628ee8e2c4.html`. The only way to be
sure is to open the files in a browser or check their creation date--it will
match when the story was played or tested.
match when the story was played or tested.
4 changes: 2 additions & 2 deletions docs/en/src/troubleshooting/damaged-story.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ In some cases, solving this problem is as easy as quitting and re-opening app
Twine or reloading browser Twine. When Twine first starts up, it checks your
stories for possible problems and repairs them where it can.

But if restarting Twien doesn't help, you'll probably need to [restore a backup
version of your story](backups.md).
But if restarting Twine doesn't help, you'll probably need to [restore a backup
version of your story](backups.md).
2 changes: 1 addition & 1 deletion docs/en/src/troubleshooting/error-message.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ Twine offers two options in this situation.
story file outside your story library folder before choosing this option.
- Keep the file as it is and relaunch Twine. This will cause any pending
change that hasn't been saved to be lost, but the change is likely to be very
small, since Twine saves changes as you work.
small, since Twine saves changes as you work.
2 changes: 1 addition & 1 deletion docs/en/src/troubleshooting/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Troubleshooting Problems

Sometimes things go wrong while working with Twine. This section contains advice
on how to handle these situations.
on how to handle these situations.
2 changes: 1 addition & 1 deletion docs/en/src/troubleshooting/local-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ common ones:

Be careful when working with local storage, however. Just looking at what's in
local storage, or copying and pasting out of it can't cause any harm. But adding
even one stray extra character can cause Twine to be unable to read the data.
even one stray extra character can cause Twine to be unable to read the data.
2 changes: 1 addition & 1 deletion docs/en/src/troubleshooting/lost-story.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ This is most likely caused by Twine having trouble with some aspect of your
story, for example if the HTML structure of your story file became damaged. If
you see the file in your story library folder, try opening it in a plain text
editor. As above, you might be able to edit the files directly and repair them,
or recreate your story using them as a guide.
or recreate your story using them as a guide.
2 changes: 1 addition & 1 deletion docs/en/src/troubleshooting/wont-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ on what operating system you're using.
`%AppData%` into the location bar of an Explorer window.

To reset your preferences, delete the `prefs.json` file and re-open Twine. It
will restore preferences to defaults and try to continue loading.
will restore preferences to defaults and try to continue loading.
Loading