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

Link to format documentation #301

Open klembot opened 7 years ago

klembot commented 7 years ago

Originally reported by: Thomas M. Edwards (Bitbucket: tmedwards, GitHub: tmedwards)


I think it would be a good idea to have a documentation link property within the format JSON. I'm thinking it would be best to expose it within the various format windows—say an extra column or whatever—and additionally, for story formats, within the story editor window—say an extra button on the bar.

This is of particular interest if the current format window design—as of 2.1.0b4—is kept as it does away with the description field, which was the only place were a format could previously expose a link to its documentation. Even if format descriptions are restored before the full release, a dedicated documentation link would still be desirable.


klembot commented 7 years ago

Original comment by Thomas M. Edwards (Bitbucket: tmedwards, GitHub: tmedwards):


[…] as it does away with the description field […]

I see now that this is only true for the global format window, while the story editor format window retains the description. Still, the point is the same.