revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-12-19 12:00:55 +01:00
Code Issues Releases Wiki Activity

Improve remarkup documentation

Browse source 
Summary:
Some user feedback:

  - Named link information not present in quick reference.
  - Named link information buried in Phriction docs.
  - Optional omission of trailing "=" in headers not documented.

Fix these things.

Test Plan: generated, read documentation

Reviewers: btrahan, paularmstrong, Josereyes

Reviewed By: btrahan

CC: aran, epriestley

Maniphest Tasks: T884

Differential Revision: https://secure.phabricator.com/D1637
This commit is contained in:
epriestley 2012-02-17 19:39:13 -08:00
parent 2cf26d8036
commit ab9c6f10d0
1 changed files with 22 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
src/docs/userguide/remarkup.diviner
View file

@ -22,13 +22,17 @@ These are inline styles, and can be applied to most text:
D123 T123 rX123 # Link to Objects D123 T123 rX123 # Link to Objects
{D123} {T123} # Link to Objects (Full Name) {D123} {T123} # Link to Objects (Full Name)
{F123} # Embed Images {F123} # Embed Images
[[wiki page]] # Link to Phriction
@username # Mention a user @username # Mention a user
[[wiki page]] # Link to Phriction
[[wiki page | name]] # Named link to Phriction
http://xyz/ # Link to web
[[http://xyz/ | name]] # Named link to web
These are block styles, and must be separated from surrounding text by These are block styles, and must be separated from surrounding text by
empty lines: empty lines:
= Large Header= = Large Header =
== Smaller Header == == Smaller Header ==
> Quoted Text > Quoted Text
Use "- " or "* " for list items. Use "- " or "* " for list items.
@ -56,6 +60,12 @@ Make **headers** like this:
===== Very Small Header ===== ===== Very Small Header =====
You can optionally omit the trailing "=" signs -- that is, these are the same:
== Smaller Header ==
== Smaller Header
This produces headers like the ones in this document. Make sure you have an This produces headers like the ones in this document. Make sure you have an
empty line before and after the header. empty line before and after the header.
@ -176,6 +186,12 @@ If you have a URI with problematic characters in it, like
This will force the parser to consume the whole URI: <http://comma.org/,> This will force the parser to consume the whole URI: <http://comma.org/,>
You can also use create named links, where you choose the displayed text. These
work within Phabricator or on the internet at large:
[[/herald/transcript/ | Herald Transcripts]]
[[http://www.boring-legal-documents.com/ | exciting legal documents]]
= Linking to Objects = = Linking to Objects =
You can link to Differential revisions, Diffusion commits and Maniphest tasks You can link to Differential revisions, Diffusion commits and Maniphest tasks
@ -270,12 +286,6 @@ opponents:
Check out these [[legal/boring_documents/ | exciting legal documents]]! Check out these [[legal/boring_documents/ | exciting legal documents]]!
You can also use this as an explicit syntax for other web links, either within
Phabricator or on the internet at large:
[[/herald/transcript/ | Herald Transcripts]]
[[http://www.boring-legal-documents.com/ | exciting legal documents]]
= Literal Blocks = = Literal Blocks =
To place text in a literal block use "%%%": To place text in a literal block use "%%%":