Changeset View
Changeset View
Standalone View
Standalone View
src/docs/user/userguide/remarkup.diviner
@title Remarkup Reference | @title Remarkup Reference | ||||
@group userguide | @group userguide | ||||
Explains how to make bold text; this makes your words louder so you can win | Explains how to make bold text; this makes your words louder so you can win | ||||
arguments. | arguments. | ||||
= Overview = | = Overview = | ||||
Phabricator uses a lightweight markup language called "Remarkup", similar to | Phorge uses a lightweight markup language called "Remarkup", similar to | ||||
other lightweight markup languages like Markdown and Wiki markup. | other lightweight markup languages like Markdown and Wiki markup. | ||||
This document describes how to format text using Remarkup. | This document describes how to format text using Remarkup. | ||||
= Quick Reference = | = Quick Reference = | ||||
All the syntax is explained in more detail below, but this is a quick guide to | All the syntax is explained in more detail below, but this is a quick guide to | ||||
formatting text in Remarkup. | formatting text in Remarkup. | ||||
▲ Show 20 Lines • Show All 308 Lines • ▼ Show 20 Lines | |||||
--- | --- | ||||
On an entirely different topic, ... | On an entirely different topic, ... | ||||
``` | ``` | ||||
= Linking URIs = | = Linking URIs = | ||||
URIs are automatically linked: http://phabricator.org/ | URIs are automatically linked: http://phorge.it/ | ||||
If you have a URI with problematic characters in it, like | If you have a URI with problematic characters in it, like | ||||
"`http://comma.org/,`", you can surround it with angle brackets: | "`http://comma.org/,`", you can surround it with angle brackets: | ||||
<http://comma.org/,> | <http://comma.org/,> | ||||
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 | You can also use create named links, where you choose the displayed text. These | ||||
work within Phabricator or on the internet at large: | work within Phorge or on the internet at large: | ||||
[[/herald/transcript/ | Herald Transcripts]] | [[/herald/transcript/ | Herald Transcripts]] | ||||
[[http://www.boring-legal-documents.com/ | exciting legal documents]] | [[http://www.boring-legal-documents.com/ | exciting legal documents]] | ||||
Markdown-style links are also supported: | Markdown-style links are also supported: | ||||
[Toil](http://www.trouble.com) | [Toil](http://www.trouble.com) | ||||
= Linking to Objects = | = Linking to Objects = | ||||
You can link to Phabricator objects, such as Differential revisions, Diffusion | You can link to Phorge objects, such as Differential revisions, Diffusion | ||||
commits and Maniphest tasks, by mentioning the name of an object: | commits and Maniphest tasks, by mentioning the name of an object: | ||||
D123 # Link to Differential revision D123 | D123 # Link to Differential revision D123 | ||||
rX123 # Link to SVN commit 123 from the "X" repository | rX123 # Link to SVN commit 123 from the "X" repository | ||||
rXaf3192cd5 # Link to Git commit "af3192cd5..." from the "X" repository. | rXaf3192cd5 # Link to Git commit "af3192cd5..." from the "X" repository. | ||||
# You must specify at least 7 characters of the hash. | # You must specify at least 7 characters of the hash. | ||||
T123 # Link to Maniphest task T123 | T123 # Link to Maniphest task T123 | ||||
You can also link directly to a comment in Maniphest and Differential (these | You can also link directly to a comment in Maniphest and Differential (these | ||||
can be found on the date stamp of any transaction/comment): | can be found on the date stamp of any transaction/comment): | ||||
T123#412 # Link to comment id #412 of task T123 | T123#412 # Link to comment id #412 of task T123 | ||||
See the Phabricator configuration setting `remarkup.ignored-object-names` to | See the Phorge configuration setting `remarkup.ignored-object-names` to | ||||
modify this behavior. | modify this behavior. | ||||
= Embedding Objects | = Embedding Objects | ||||
You can also generate full-name references to some objects by using braces: | You can also generate full-name references to some objects by using braces: | ||||
{D123} # Link to Differential revision D123 with the full name | {D123} # Link to Differential revision D123 with the full name | ||||
{T123} # Link to Maniphest task T123 with the full name | {T123} # Link to Maniphest task T123 with the full name | ||||
▲ Show 20 Lines • Show All 118 Lines • ▼ Show 20 Lines | |||||
You can also use image macros in the context of memes. For example, if you | You can also use image macros in the context of memes. For example, if you | ||||
have an image macro named `grumpy`, you can create a meme by doing the | have an image macro named `grumpy`, you can create a meme by doing the | ||||
following: | following: | ||||
{meme, src = grumpy, above = toptextgoeshere, below = bottomtextgoeshere} | {meme, src = grumpy, above = toptextgoeshere, below = bottomtextgoeshere} | ||||
By default, the font used to create the text for the meme is `tuffy.ttf`. For | By default, the font used to create the text for the meme is `tuffy.ttf`. For | ||||
the more authentic feel of `impact.ttf`, you simply have to place the Impact | the more authentic feel of `impact.ttf`, you simply have to place the Impact | ||||
TrueType font in the Phabricator subfolder `/resources/font/`. If Remarkup | TrueType font in the Phorge subfolder `/resources/font/`. If Remarkup | ||||
detects the presence of `impact.ttf`, it will automatically use it. | detects the presence of `impact.ttf`, it will automatically use it. | ||||
= Mentioning Users = | = Mentioning Users = | ||||
In Differential and Maniphest, you can mention another user by writing: | In Differential and Maniphest, you can mention another user by writing: | ||||
@username | @username | ||||
▲ Show 20 Lines • Show All 222 Lines • Show Last 20 Lines |
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0