Consider rewording passageTextPlaceholder from "To link to another passage, put two square brackets around its name, [[like this]]."

klembot / twinejs

Twine, a tool for telling interactive, nonlinear stories

https://twinery.org

GNU General Public License v3.0

2k stars 295 forks source link

Consider rewording passageTextPlaceholder from "To link to another passage, put two square brackets around its name, [[like this]]." #1160

Open webbedspace opened 2 years ago

webbedspace commented 2 years ago

The problem here is that it lists a single syntax feature (simple links) even though there's no real onus on every story format to support it. As such, it's liable to be flat-out incorrect.

Possibly you could allow story formats to specify their own placeholder string (which is what I'd been doing for Harlowe 3.2 anyway). At worst, you could just remove the second sentence.

Presubmission checklist

[ ] I am interested in working on code that would implement this feature request. (This is not required to submit a suggestion.)
[X] I have done a search and believe that an issue does not already exist for this idea in the GitHub repository.
[X] I have read and agree to abide by this project's Code of Conduct.

greyelf commented 2 years ago

One potential issue is that currently a Markup based link is the only means (1) available for generating a Connection between two Passage.

...even though there's no real onus on every story format to support it

Other that the fact that story format developers likely understand that many (most) Authors use the GUI application so they have access to a Passage Map, instead of a Text Editor plus TWEE Compiler,

(1) Other than embedding the Markup link within a comment, and relying on the fact that currently the application doesn't exclude the content of comments in its searching for "links".

klembot commented 2 years ago

Disagree a bit, because double brackets are the one lingua franca among story formats. @webbedspace, I know you're in favor of allowing story formats to replace Twine's link parser completely (I think you raised this originally in #942) but I think right now the negatives of that outweigh the positives.

I think there's no harm in allowing story formats to set their own placeholder text, though this means shifting the burden of localization onto them. Something along the lines of a placeholder: (language: string) => string property, where language is a locale code.