aboutsummaryrefslogtreecommitdiff
path: root/dists/riscos/manual/stronghelp.lua
blob: ef17589dd7f1fe4d17794db43beaea84ec39ba41 (plain)
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
-- This is a custom writer for pandoc.  It produces output suitable
-- for use in a StrongHelp manual. Not all functionalilty is currently
-- implemented.
--
-- Invoke with: pandoc -t stronghelp.lua
--
-- Note:  you need not have lua installed on your system to use this
-- custom writer.  However, if you do have lua installed, you can
-- use it to test changes to the script.  'lua stronghelp.lua' will
-- produce informative error messages if your code contains
-- syntax errors.

-- Character escaping
local function escape(s, in_attribute)
  return s:gsub("[<>$\\]",
    function(x)
      if x == '<' then
        return '\\<'
      elseif x == '>' then
        return '\\>'
      elseif x == '$' then
        return '\\$'
      elseif x == '\\' then
        return '\\\\'
      else
        return x
      end
    end)
end

local function convertPath(s)
  local path = s:gsub("[./]",
    function(x)
      if x == '.' then
        return '/'
      elseif x == '/' then
        return '.'
      else
        return x
      end
    end)
  path = string.gsub(path, "/md", "")
  return path;
end

-- Helper function to convert an attributes table into
-- a string that can be put into HTML tags.
local function attributes(attr)
  local attr_table = {}
  for x,y in pairs(attr) do
    if y and y ~= "" then
      table.insert(attr_table, ' ' .. x .. '="' .. escape(y,true) .. '"')
    end
  end
  return table.concat(attr_table)
end

-- Helper function to look up an attribute by name from
--  an attributes table.
-- TODO: Is this necessary?
local function getattribute(attr, name)
  local attr_table = {}
  for x,y in pairs(attr) do
    if x == name then
      do return escape(y,true) end
    end
  end
  return ""
end

-- Table to store footnotes, so they can be included at the end.
local notes = {}

-- Blocksep is used to separate block elements.
function Blocksep()
  return "\n\n"
end

-- This function is called once for the whole document. Parameters:
-- body is a string, metadata is a table, variables is a table.
-- This gives you a fragment.  You could use the metadata table to
-- fill variables in a custom lua template.  Or, pass `--template=...`
-- to pandoc, and pandoc will add do the template processing as
-- usual.
function Doc(body, metadata, variables)
  local buffer = {}
  local function add(s)
    table.insert(buffer, s)
  end
  add(body)
  if #notes > 0 then
    for _,note in pairs(notes) do
      add(note)
    end
  end
  return "#Indent +4\n" .. table.concat(buffer, "") .. "\n#Indent\n"
end

-- The functions that follow render corresponding pandoc elements.
-- s is always a string, attr is always a table of attributes, and
-- items is always an array of strings (the items in a list).
-- Comments indicate the types of other variables.

function Str(s)
  return escape(s)
end

function Space()
  return " "
end

function SoftBreak()
  return " "
end

function LineBreak()
  return "\n"
end

function Emph(s)
  return "{/}" .. s .. "{/}"
end

function Strong(s)
  return "{*}" .. s .. "{*}"
end

function Subscript(s)
  -- TODO
  return s
end

function Superscript(s)
  -- TODO
  return s
end

function SmallCaps(s)
  -- TODO
  return s
end

function Strikeout(s)
  -- TODO
  return s
end

function Link(s, src, tit, attr)
  -- escape(tit,true)
  if string.find(src, "://") or string.find(src, "mailto:") then
    return "<" .. s .. "=>#URL " .. escape(src,true) .. ">"
  elseif string.sub(src, 1, 1) == '#' then
    return "<" .. s .. "=>#TAG " .. escape(string.sub(src,2),true) .. ">"
  else
    return "<" .. s .. "=>" .. convertPath(escape(src,true)) .. ">"
  end
end

function Image(s, src, tit, attr)
  -- TODO
  return s
end

function Code(s, attr)
  return "{FCode}" .. escape(s) .. "{F}"
end

function InlineMath(s)
  return "\\(" .. escape(s) .. "\\)"
end

function DisplayMath(s)
  return "\\[" .. escape(s) .. "\\]"
end

function SingleQuoted(s)
  return "'" .. s .. "'"
end

function DoubleQuoted(s)
  return '"' .. s .. '"'
end


function Note(s)
  local num = #notes + 1
  -- add a list item with the note to the note table.
  table.insert(notes, '#Tag fn' .. num .. '\n' .. num .. ")\t" .. s .. '\n')
  -- return the footnote reference, linked to the note.
  return '<[' .. num .. ']=>#TAG fn' .. num .. '>'
end

function Span(s, attr)
  -- TODO
  return s
end

function RawInline(format, str)
  -- TODO
  return ''
end

function Cite(s, cs)
  -- TODO
  return s
end

function Plain(s)
  return s
end

function Para(s)
  return s
end

-- lev is an integer, the header level.
function Header(lev, s, attr)
  return  "#Tag " .. getattribute(attr, "id") .. "\n" .. "#fH" .. lev .. "\n" .. s .. "\n#f\n"
end

function BlockQuote(s)
  return "#Indent +6\n" .. s .. "\n#Indent\n"
end

function HorizontalRule()
  return "#Line\n"
end

function LineBlock(ls)
  -- TODO
  return table.concat(ls, '\n')
end

function CodeBlock(s, attr)
  -- TODO: attr.class and string.match(' ' .. attr.class .. ' ',' dot ')
  return "#fCode\n" .. escape(s) .. "\n#f"
end

function BulletList(items)
  local buffer = {}
  for _, item in pairs(items) do
    table.insert(buffer, " •\t" .. string.gsub(string.gsub(item, "\n", "\n\t"), "\n\t#", "\n#") .. "\n")
  end
  return "#Indent +4\n" .. table.concat(buffer, "") .. "#Indent\n"
end

function OrderedList(items)
  local buffer = {}
  for _, item in pairs(items) do
    table.insert(buffer,  _ .. ")\t"  .. string.gsub(string.gsub(item, "\n", "\n\t"), "\n\t#", "\n#") .. "\n")
  end
  return "#Indent +4\n" .. table.concat(buffer, "") .. "#Indent\n"
end

function DefinitionList(items)
  local buffer = {}
  for _,item in pairs(items) do
    local k, v = next(item)
    table.insert(buffer, k .. "\t" .. table.concat(v,"\n\t") .. "\n")
  end
  return "#Indent +4\n" .. table.concat(buffer, "") .. "#Indent\n"
end

-- Convert pandoc alignment to something StrongHelp can use.
-- align is AlignLeft, AlignRight, AlignCenter, or AlignDefault.
function stronghelp_align(align)
  if align == 'AlignLeft' then
    return 'Left'
  elseif align == 'AlignRight' then
    return 'Right'
  elseif align == 'AlignCenter' then
    return 'Centre'
  else
    return 'Left'
  end
end

function CaptionedImage(src, tit, caption, attr)
   -- TODO
   return tit .. '\n' .. caption .. '\n'
end

-- Caption is a string, aligns is an array of strings,
-- widths is an array of floats, headers is an array of
-- strings, rows is an array of arrays of strings.
function Table(caption, aligns, widths, headers, rows)
  local buffer = {}
  local function add(s)
    table.insert(buffer, s)
  end
  add("#Tab\n")
  if caption ~= "" then
    add(caption .. "\n")
  end
  local header_row = {}
  local empty_header = true
  for i, h in pairs(headers) do
    table.insert(header_row,h .. '\t')
    empty_header = empty_header and h == ""
  end
  if empty_header then
    head = ""
  else
    local cells = {}
    for _,h in pairs(header_row) do
      table.insert(cells, h)
    end
    add('{*}' .. table.concat(cells,'\t') .. '{*}\n')
  end
  for _, row in pairs(rows) do
    local cells = {}
    for i,c in pairs(row) do
      table.insert(cells, c)
    end
    add(table.concat(cells,'\t') .. '\n')
  end
  add("#Tab\n")
  return table.concat(buffer,'')
end

function RawBlock(format, str)
  -- TODO
  return ''
end

function Div(s, attr)
  -- TODO
  return s
end

-- The following code will produce runtime warnings when you haven't defined
-- all of the functions you need for the custom writer, so it's useful
-- to include when you're working on a writer.
local meta = {}
meta.__index =
  function(_, key)
    io.stderr:write(string.format("WARNING: Undefined function '%s'\n",key))
    return function() return "" end
  end
setmetatable(_G, meta)