-
Notifications
You must be signed in to change notification settings - Fork 3
/
block-markers.wry.txt
101 lines (85 loc) · 3.25 KB
/
block-markers.wry.txt
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
project : Wry block markers
author : Mike Weaver
created : 2018-07-25
section : Introduction
Explore what characters could be used as block markers.
section : Block markers
The following are all the common punctuation characters (on US English
keyboards) for syntax, and how they are (or might be) used in Wry.
!!!
Some things might want to include:
*
Ability to do lines with specified breaks or custom indentation, such
as poetry. As an example, in SAM this is done with a pipe character at
the beginning of the line:
```
| A pipe followed by a space
| indicates lines of text with
| fixed line breaks and indentation
An alternative would be to use a backslash to escape the indentation
that is supposed to be part of the line and not part of the document
structure.
*
Use `+++` to mark a table, with double colons as column delimiters. How
do we mark the header row? Maybe the column delimiter could be pipe?
*
SAM uses the marker >>> as in insert for, as an example, an image. In
Wry this symbol is reserved for switching between prose and code mode,
so can't be used for this purpose. But another marker could be used.
Or, accomplish this another way, with a reference in text to a field
that defines an image.
```
Some Wry prose with image reference [*image name].
image name : my_image.png
*
Equations could be handled with pre-composed text marker (three
backticks) and same for inline, surrounded by backticks, but we don't
want to see the specification in mono-spaced font, we actually want to
see the rendered equation. Sam uses an equal sign in the attribute
following the in-line code.
```(SAM) : SAM syntax for inline renders
Inline rendered content `\frac{a}{b}`(=latexmath).
We could use a `===` marker to indicate "don't print this in
mono-spaced font like a pre-composed block, but render it and replace".
But what about inline? Could surround with equal signs, similar to how
backticks are used to surround in-line pre-composed code. But that
would get confusing, especially as it seems often the text we want to
denote would include an equal sign. Could use angle brackets, showing a
similarity between popping out of prose mode to some sort of code mode.
Or could use curly brackets with an equal sign around the embedded
text, which makes the equal sign "magic" inside curly braces. That
problem exists with SAM's approach, where equal sign is magic in the
attribute parens.
+++ : Table of block markers
marker :: description
``` :: pre-composed text, prose mode
!!! :: remark, prose mode
$$$ :: terminal session text, prose mode
<<< :: open or close code mode
>>> :: close or open code mode
+++ :: tables, with `::` as column delimiter
""" :: block quote, prose mode
/// :: comment block, code mode
=== :: (maybe) embed block, prose mode
~~~ ::
@@@ ::
### ::
%%% ::
^^^ ::
&&& ::
*** ::
((( ::
))) ::
--- :: (hyphen)
___ :: (underscore)
||| ::
::: ::
''' ::
??? ::
;;; :: not used
{{{ :: not used
}}} :: not used
[[[ :: not used
]]] :: not used
,,, :: (comma) not used
... :: (period) not used