Replacement for the highlight and comment syntax

Gabe's Avatar

Gabe

13 Feb, 2013 02:12 PM

There's been some concern about the CM syntax for highlights conflicting with static blog templating engines like Mustache. These are very common and present a real concern for the use of CM everywhere that Markdown is supported.

We are considering the following change to the syntax. This syntax will be deprecated:

 {{Some highlighted text}}{>>editors comment<<}

And replaced with the following syntax:

 {==Some highlighted text==}{>>editors comment<<}

or

 {::Some highlighted text::}{>>editors comment<<}

If we are going to change this core syntax, we need to do it now. If there is a concern about either of these, it we be helpful to raise it now.

  1. 1 Posted by Mark Siegal on 13 Feb, 2013 02:30 PM

    Mark Siegal's Avatar

    The proposed syntax change looks good to me. Of these alternatives, I prefer {==Some highlighted text==}. It fits in well with using ++/-- for addition/deletion, since if you're highlighting something it's staying unchanged ("equal" to itself).

  2. 2 Posted by fredrik.stl on 13 Feb, 2013 06:50 PM

    fredrik.stl's Avatar

    I agree with Mark! It makes sense!

  3. 3 Posted by Brandon Mathis on 14 Feb, 2013 05:25 AM

    Brandon Mathis's Avatar

    I'm also a fan of the {== highlighted text ==} syntax. For the reasons Mark stated as well as the fact that with more substance, it stands out better than the colons do. It draws attention much like highlighted text would.

    One other small benefit for = is that { } = and + are on the same keyboard pane in iOS.

  4. Support Staff 4 Posted by Gabe on 14 Feb, 2013 11:23 AM

    Gabe's Avatar

    We think alike. Every time we choose a new syntax, I check the iOS keyboard.

  5. 5 Posted by Christian on 14 Feb, 2013 02:25 PM

    Christian's Avatar

    +1 for {== foo ==}{>>bar<<} syntax

  6. 6 Posted by Russ on 14 Feb, 2013 02:55 PM

    Russ's Avatar

    +1 for {==Some highlighted text==}{>>editors comment<<} syntax

  7. Support Staff 7 Posted by Gabe on 15 Feb, 2013 02:48 PM

    Gabe's Avatar

    The Syntax and toolkits will be updated this weekend. We are making the following change:

     {{Some highlighted text}}{>>editors comment<<}
    

    And replaced with the following syntax:

     {==Some highlighted text==}{>>editors comment<<}
    
  8. Gabe closed this discussion on 15 Feb, 2013 02:48 PM.

Comments are currently closed for this discussion. You can start a new one.

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