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

Rethink problematic macros #19

Open
5 tasks
tmedwards opened this issue May 10, 2020 · 2 comments
Open
5 tasks

Rethink problematic macros #19

tmedwards opened this issue May 10, 2020 · 2 comments
Assignees
Labels
enhancement New feature or request todo Make this happen

Comments

@tmedwards
Copy link
Owner

Rethink—rework, repurpose, or remove—problematic macros.

  • <<actions>> – Either confusing or a poor fit for what most want to do with it.
  • <<back>> – Name is confusing to some. Possibly rename to <<undo>>?
  • <<choice>> – Either confusing or a poor fit for what most want to do with it.
  • <<return>> – Name is confusing to some and doesn't currently work for long return cases.
  • <<silently>> – Macro is fine, I just dislike the name. Possibly rename to <<silent>>?
@tmedwards tmedwards self-assigned this May 21, 2020
@tmedwards tmedwards transferred this issue from another repository Aug 2, 2020
@tmedwards tmedwards added enhancement New feature or request todo Make this happen labels Aug 2, 2020
@Uzume
Copy link

Uzume commented Oct 24, 2020

<<actions>> and <<choice>> seem mostly applicable in the same way and go along with creating/manipulating disabled controls not unlike tmedwards/sugarcube-2#46. Methinks all controls including simple passage links should have some means of displaying a disabled version of them. This allows the author to give the reader clues that certain actions would have been available if something was different. The most obvious example would be a passage link that was locked by some condition, however, even textboxes, etc. should have a means to display them in a disabled state (e.g., providing the player with a way to name the main character but in some situations unable to remember, etc.).

Renaming <<back>> could be a moot point if current/unexpired history goes away with #20.

<<return>> seems confusing. What does it do if given a passage name that is not previously visited (i.e., not in its history)?. It seems to me this would be better as a new <<back>> macro that has an argument on how far back in history to return to which passage. It would default to 1 meaning link to the previous visited passage (but not undoing history). The documentation would likely want to reiterate the usual warnings about visiting the same passages multiple times.

Methinks <<silently>> would be better named something like <<discard>> or <<discardoutput>>, etc.

@HiEv
Copy link

HiEv commented Oct 6, 2021

Perhaps instead of <<silently>> you could use <<mute>> instead? It's shorter to type and means the same thing, though it may be confused for an audio macro (but I guess <<silently>> could also be confused for one). Alternately, <<hide>> might work, since it's short and fairly clear (unless you decide you also want a DOM macro which hides HTML elements).

As for <<return>>, how about <<gotolast [tagname(s) to skip]>> which will take them forward to the last passage they were at previously which doesn't have any of the tag names passed in as parameters to that macro. That clarifies what the macro does and also simplifies resolving the "long return" problem. (Also, I agree that changing <<back>> to <<undo>> would be good, since I could never keep straight in my head which one of these two macros did the undo and which didn't.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request todo Make this happen
Projects
None yet
Development

No branches or pull requests

3 participants