-
Notifications
You must be signed in to change notification settings - Fork 3
/
phrase_modifiers.yaml
115 lines (112 loc) · 6.79 KB
/
phrase_modifiers.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
Strong importance:
Strong importance:
desc: Strong importance can be given to the text by surrounding it with asterisks. The
strong text is commonly styled as **bold**.
input: Don't *ever* pull this lever.
output: <p>Don’t <strong>ever</strong> pull this lever.</p>
Stress emphasis:
Stress emphasis:
desc: To add emphasis to a stressed word or phrase, surround it with underscores. Emphasized
text is typically styled as __italics__.
input: You didn't actually _believe_ her, did you?
output: <p>You didn’t actually <em>believe</em> her, did you?</p>
Stylistic offset:
Stylistic offset:
desc: To stylistically differentiate a word or phrase from the surrounding text
*without conveying any extra importance*, place two asterisks on either side. Uses
are key words in a document abstract, product names in a review, or other
spans of text whose typical typographic presentation is boldened.
input: |-
Search results for **Textile**:
h4. ["**Textile** (markup language) - Wikipedia":http://en.wikipedia.org/wiki/Textile_(markup_language)]
**Textile** is a lightweight markup language originally developed by Dean Allen and billed as a "humane Web text generator". **Textile** converts its marked-up text ...
output: |-
<p>Search results for <b>Textile</b>:</p>
<h4><a href="http://en.wikipedia.org/wiki/Textile_(markup_language)"><b>Textile</b> (markup language) – Wikipedia</a></h4>
<p><b>Textile</b> is a lightweight markup language originally developed by Dean Allen and billed as a “humane Web text generator”. <b>Textile</b> converts its marked-up text …</p>
Alternate voice:
Alternate voice:
desc: Double underscores surround a span of text in an alternate mood or voice,
a technical term, an idiomatic phrase from another language, a thought, a
ship name, or some other prose whose typical typographic presentation is italicized.
input: I just got the weirdest feeling of __déjà vu__.
output: <p>I just got the weirdest feeling of <i>déjà vu</i>.</p>
Citation:
Citation:
desc: Cite the title of a work (e.g. a book, paper, essay, poem, score, song,
script, film, TV show, game, sculpture, painting, theater production, play,
opera, musical, exhibition, or anything other work whose title is italicized
in traditional style guides) by surrounding it with two question marks on
either side. This can be a work that is being quoted or referenced in detail
(i.e. a citation), or it can just be a work that is mentioned in passing.
input: My wife's favorite book is ??The Count of Monte Cristo?? by Dumas.
output: <p>My wife’s favorite book is <cite>The Count of Monte Cristo</cite>
by Dumas.</p>
Insertions and deletions:
Insertions and deletions:
desc: To indicate a passage which has been deleted, surround it with minuses. To
indicate an insertion, use pluses.
input: The news networks declared -Al Gore- +George W. Bush+ the winner in Florida.
output: <p>The news networks declared <del>Al Gore</del> <ins>George W. Bush</ins>
the winner in Florida.</p>
Explicit insertion and deletion:
desc: If your insertion or deletion isn't being recognized or is being confused
with another modifier, you can make it more explicit by surrounding it with
square brackets.
input: '[-this was deleted-][+this was added+] to the paragraph'
output: <p><del>this was deleted</del><ins>this was added</ins> to the paragraph</p>
Superscript and subscript:
Superscript and subscript:
desc: Superscript and subscript phrases are surrounded with caret and tilde
characters, respectively.
input: "f(x, n) = log ~4~ x ^n^\r\n"
output: <p>f(x, n) = log <sub>4</sub> x <sup>n</sup></p>
Tight superscript and subscript:
desc: If you want it without spaces around the super- and subscripted text,
use square brackets.
input: f(x, n) = log[~4~]x[^n^]
output: <p>f(x, n) = log<sub>4</sub>x<sup>n</sup></p>
Links:
Links:
desc: Links have the text of the link in quotes, followed by a colon and the
URL.
input: Learn more "about the company":/about and our "board of directors":../about#board.
output: <p>Learn more <a href="/about">about the company</a> and our <a href="../about#board">board
of directors</a>.</p>
Link title:
desc: |-
A title may be placed in parentheses at the end of the link text. Link titles help users predict where they are going. "Jakob Nielsen(Nielsen's guidelines for link titles)":http://www.useit.com/alertbox/980111.html recommends you use them sparingly and not assume the user will see them at all.
input: Visit our "parent company (Example Corporation)":http://example.com.
output: <p>Visit our <a href="http://example.com" title="Example Corporation">parent
company</a>.</p>
Bracketed link:
desc: When the link isn't surrounded by spaces or punctuation, or when the URL
ending may be ambiguous, surround the link with square brackets.
input: This is a link to a ["Wikipedia article about Textile":http://en.wikipedia.org/wiki/Textile_(markup_language)].
output: <p>This is a link to a <a href="http://en.wikipedia.org/wiki/Textile_(markup_language)">Wikipedia
article about Textile</a>.</p>
Link alias:
desc: If you link to a URL repeatedly, you can replace the URL with a link alias
defined elsewhere in the Textile document.
input: |-
I'm really excited about "Textile":textile. I love it so much, I think I'll name my first child "Tex":textile.
[textile]http://textileit.com
output: <p>I’m really excited about <a href="http://textileit.com">Textile</a>. I love it so much, I think I’ll name my first child <a href="http://textileit.com">Tex</a>.</p>
Link attributes:
desc: Link "attributes":../attributes can be specified at the beginning of the
link text followed by a period and space.
input: '"(my-class). This is a link with class":http://textileit.com'
output: <p><a href="http://textileit.com" class="my-class">This is a link with
class</a></p>
Images:
Images:
desc: Include an image by surrounding its URL with exclamation marks. Alt text
can be provided in parentheses.
input: '!http://www.w3.org/Icons/valid-html401(This page is valid HTML)!'
output: <p><img src="http://www.w3.org/Icons/valid-html401" title="This page
is valid HTML" alt="This page is valid HTML" /></p>
Image links:
desc: Images can be linked by putting a colon and the link URL after the image.
input: '!http://www.w3.org/Icons/valid-html401!:http://validator.w3.org/check?uri=referer'
output: <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-html401"
alt="" /></a></p>