flatiron 1.0.5

A parser and HTML renderer for the Textile markup language
Documentation 
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

#[derive(Debug, PartialEq)]
pub struct Textile(pub Vec<BlockTag>);

#[derive(Debug, PartialEq)]
pub enum BlockTag {
    Basic {
        kind: BlockKind,
        header: BlockHeader,
        content: InlineTag,
    },
    Preformatted {
        kind: BlockKind,
        header: BlockHeader,
        content: String,
    },
    List {
        header: BlockHeader,
        content: List,
    },
    Table {
        header: BlockHeader,
        rows: Vec<TableRow>,
    },
    NoTextile(String),
}

#[derive(Debug, PartialEq, Clone, Copy)]
pub enum BlockKind {
    Paragraph,
    NoTextile,
    BlockQuote,
    BlockCode,
    Preformatted,
    Header(usize),
    Footnote(usize),
}

#[derive(Debug, PartialEq)]
pub struct BlockHeader {
    pub attributes: Option<Attributes>,
    pub indent: Option<Indent>,
    pub align: Option<Align>,
}

#[derive(Debug, PartialEq)]
pub struct List {
    pub kind: ListKind,
    pub items: Vec<ListItem>,
}

#[derive(Debug, PartialEq)]
pub struct ListItem {
    pub content: InlineTag,
    pub sublist: Option<List>,
}

#[derive(Debug, PartialEq, Clone, Copy)]
pub enum ListKind {
    Numeric,
    Bulleted,
}

#[derive(Debug, PartialEq)]
pub struct TableRow {
    pub header: TableHeader,
    pub cells: Vec<TableCell>,
}

#[derive(Debug, PartialEq)]
pub struct TableHeader {
    pub attributes: Option<Attributes>,
    pub h_align: Option<Align>,
    pub v_align: Option<VerticalAlign>,
}

#[derive(Debug, PartialEq)]
pub struct TableCell {
    pub kind: CellKind,
    pub col_span: Option<usize>,
    pub row_span: Option<usize>,
    pub header: TableHeader,
    pub content: InlineTag,
}

#[derive(Debug, PartialEq, Clone, Copy)]
pub enum CellKind {
    Header,
    Data,
}

#[derive(Debug, PartialEq, Clone)]
pub struct Indent {
    pub left: usize,
    pub right: usize,
}

#[derive(Debug, PartialEq, Clone, Copy)]
pub enum Align {
    Left,
    Right,
    Center,
    Justify,
}

#[derive(Debug, PartialEq, Clone, Copy)]
pub enum VerticalAlign {
    Top,
    Middle,
    Bottom,
}

#[derive(Debug, PartialEq, Clone)]
pub struct Attributes {
    pub class: Option<String>,
    pub id: Option<String>,
    pub style: Option<String>,
    pub language: Option<String>,
}

#[derive(Debug, PartialEq)]
pub enum InlineTag {
    Plaintext(String),
    NoTextile(String),
    Code(String),
    FootnoteRef(usize),
    LineBreak,
    Image {
        header: ImageHeader,
        url: String,
        alt: Option<String>,
    },
    Acronym {
        title: Option<String>,
        content: String,
    },
    Link {
        attributes: Option<Attributes>,
        title: Option<String>,
        url: String,
        content: Box<InlineTag>,
    },
    Phrase {
        kind: Option<PhraseKind>,
        attributes: Option<Attributes>,
        content: Vec<InlineTag>,
    },
}

#[derive(Debug, PartialEq)]
pub struct ImageHeader {
    pub attributes: Option<Attributes>,
    pub align: Option<ImageAlign>,
}

#[derive(Debug, PartialEq, Clone, Copy)]
pub enum ImageAlign {
    Left,
    Right,
    Center,
}

#[derive(Debug, PartialEq, Clone, Copy)]
pub enum PhraseKind {
    Italic,
    Bold,
    Emphasis,
    Strong,
    Citation,
    Deleted,
    Inserted,
    Superscript,
    Subscript,
    Span,
}