revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2025-01-10 23:01:04 +01:00
Code Issues Releases Wiki Activity

Clarify that NOTE, etc., are separate block level elements

Browse source 
Summary: Fixes T6965.

Test Plan: Read documentation.

Reviewers: btrahan, chad

Reviewed By: chad

Subscribers: epriestley

Maniphest Tasks: T6965

Differential Revision: https://secure.phabricator.com/D11941
This commit is contained in:
epriestley 2015-03-02 18:17:41 -08:00
parent a76049abd4
commit 26268c6362
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/docs/user/userguide/remarkup.diviner
View file

@ -258,18 +258,30 @@ You can use `lines=N` to limit the vertical size of a chunk of code, and
<p>Mangostine</p>
<p>Melon</p>
You can also use `NOTE:`, `WARNING:`, or `IMPORTANT:` to call out an important
idea.
You can use the `NOTE:`, `WARNING:` or `IMPORTANT:` elements to call attention
to an important idea.
For example, write this:
```
NOTE: Best practices in proton pack operation include not crossing the streams.
```
...to produce this:
NOTE: Best practices in proton pack operation include not crossing the streams.
Using `WARNING:` or `IMPORTANT:` at the beginning of the line changes the
color of the callout:
WARNING: Crossing the streams can result in total protonic reversal!
IMPORTANT: Don't cross the streams!
In addition, you can use `(NOTE)`, `(WARNING)`, or `(IMPORTANT)` to get the
same effect but without `(NOTE)`, `(WARNING)`, or `(IMPORTANT)` appearing in
the rendered result. For example
the rendered result. For example, this callout uses `(NOTE)`:
(NOTE) Dr. Egon Spengler is the best resource for additional proton pack
questions.