Page MenuHomePhabricator
Create Task
Maniphest T6965

Disambiguate and provide better examples for "NOTE:" syntax in Remarkup documentation
Closed, ResolvedPublic
Actions

Description

The reporting user read the documentation as suggesting that this is the "note" syntax:

NOTE
Some note text here, in a codeblock.

It could be more clear that "NOTE", "WARNING" and "IMPORTANT" are not part of the code block syntax, and are separate block elements.

Original Report

When trying to set a code block as a note, warning or important (as specified here) the keyword isn't parsed/recognised. For example,

warning
This won't be set as a warning

Counterexample will work on the other hand:

This is a counter example

Revisions and Commits

Restricted Differential RevisionRestricted Diffusion Commit

Event Timeline

• pmoreau created this task.Jan 13 2015, 11:05 PM
• pmoreau raised the priority of this task from to Needs Triage.
• pmoreau updated the task description. (Show Details)
• pmoreau added a project: Remarkup.
• pmoreau added a subscriber: • pmoreau.
epriestley added a subscriber: epriestley.Jan 13 2015, 11:07 PM

Just write this:

NOTE: This is a note.

This produces:

NOTE: This is a note.

These layout blocks are not part of the code block syntax; they are not code blocks.

epriestley renamed this task from Note, warning and important layouts are not parsed to Disambiguate and provide better examples for "NOTE:" syntax in Remarkup documentation.Jan 13 2015, 11:09 PM
epriestley triaged this task as Wishlist priority.
epriestley updated the task description. (Show Details)
epriestley added a project: Documentation.
epriestley added a revision: Restricted Differential Revision.Mar 3 2015, 1:57 AM
epriestley closed this task as Resolved by committing Restricted Diffusion Commit.Mar 3 2015, 2:17 AM
epriestley added a commit: Restricted Diffusion Commit.
Phabricator · Built by Phacility