Simpler Additions for Small Punctuation Edits

michaelmerline's Avatar

michaelmerline

18 Feb, 2013 03:00 PM

While the large text blocks in the CrtiticMarkup syntax make for legible additions with larger chunks of text, it would be useful to integrate a simpler method of highlighting small punctuation changes.

For example, added, removed or substituted characters could be surrounded by a single unicode pairing, or a similar solution.

  1. 1 Posted by michaelmerline on 18 Feb, 2013 03:10 PM

    michaelmerline's Avatar

    As an example, a comma is being added in the following using back-slashes.

    Don't act so surprised\\,\\ Your Highness. You weren't on any mercy mission this time.
    

    I have extremely limited experience with coding systems, so I don't know what unicode character sets would avoid potential conflicts. Items like bnllets, degrees, daggers or lozenges may be safe and easy to read, but are difficult to type easily without a text-expander.

  2. Support Staff 2 Posted by Gabe on 19 Feb, 2013 02:08 PM

    Gabe's Avatar

    Thanks for the input Michael,

    I agree. We discussed similar markup options for punctuation. One thing that was an immediate concern was that such small changes were difficult to see in a large document. While it is slightly less easy to see and read, {++,++} is considerable more distinct and stands out better in a large block of text. The additional cost is only two characters.

    Sidenote: When you mention unicode that would imply a large number of characters that we would not want to use. We limit ourselves to characters available on a standard US keyboard (like your example).

    The other thing we are trying to do is carve out a consistent syntax that is easy for people to remember. We've pretty much settled on the curly brace and a repeat pattern. We considered double square brackets such as [[,]] but that syntax is already used in a couple of other domains for wiki linking.

    We're not averse to a shorter syntax but you can see some of the things we are concerned with. It's a fine line. We want it to be easy to read but also to be obvious and standout from the rest of the text.

  3. 3 Posted by michaelmerline on 19 Feb, 2013 03:15 PM

    michaelmerline's Avatar

    That makes sense to me! I'll ponder your larger concerns and reply if I have any viable ideas to contribute.

    Thanks for the reply Gabe.

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:

»

Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac

Recent Discussions

12 Jul, 2019 08:01 PM
10 May, 2019 05:30 PM
15 Dec, 2018 02:29 PM
17 Oct, 2018 07:57 PM
18 Aug, 2018 03:32 AM