Page MenuHomePhabricator

Add a Remarkup element for a navigation sequence
Closed, ResolvedPublic

Description

Fairly often, I write something like "Settings -> Password" in tasks and documentation, to indicate a navigation sequence that locates some UI.

It would be nice to formalize this in remarkup and render it in a pretty way. Particularly:

  • The "->" arrows look pretty yucky. This is probably the biggest issue.
  • Applying some style to the entire sequence might make it easier to parse and follow.

(I'm not sure offhand what the syntax or style should look like, I've just had this idea for a while and wanted to write it down before I forget about it again.)

Event Timeline

epriestley raised the priority of this task from to Wishlist.
epriestley updated the task description. (Show Details)
epriestley added a project: Remarkup.
epriestley added subscribers: epriestley, btrahan, chad.

I wouldn't mind -- turning into emdash either.

I'm very hesitant to do conversions like "->" into "→" or "--" into "—" without more context, since I think users tend to find them pretty annoying when they trigger by accident (and I do, too).

In the worst case, they can cause significant functional issues. For example, many commands use -- to indicate end of arguments, but if I copy/paste git checkout HEAD -- src/example.php from my CLI and don't put special formatting around it, and Remarkup converts the -- into , a user will now get a different result when they copy/paste the command and run it.

I saw a recent error like this on Reddit somewhere, where there was some Google config thing documented as MANIFEST-INF or similar, but the documentation engine had rewritten the hyphen into an en dash, so copy/pasting from the documentation produced nonfunctional code which was broken in a way that was nearly impossible to detect.

On OS X, one possible workaround is to use ((System Preferences... ~> Language & Text ~> Text ~> Use symbol and text substitution)) to define sequences which are replaced with unicode equivalents for symbols which aren't easy to write. For example, I have a rule which replaces snowman with , which is extremely useful in many situations.

Is it ok for me to say I'm not bothered by text arrows? :)

Shh! They might revoke your membership at Fancy Designer Typography Club!

This is completely silly, but it bothers me to no end every time I write them in docs so I'm going to do something here.

Phabricator HomeSettingsPasswordSet a Password...