FilesExpand file tree

 advutils

/

markdown.lua

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

231 lines (186 loc) · 7.13 KB

 advutils

/

markdown.lua

Copy path

Top

File metadata and controls

• Code
• Blame

231 lines (186 loc) · 7.13 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

-- Save a copy of a text screen in markdown (for reddit among others). Use 'markdown help' for more details.

-- This is a derivatiwe work based upon scripts/forum-dwarves.lua by Caldfir and expwnent

-- Adapted for markdown by Mchl https://github.com/Mchl

local args = {...}

if args[1] == 'help' then

print([[

description:

This script will attempt to read the current df-screen, and if it is a

text-viewscreen (such as the dwarf 'thoughts' screen or an item / creature

'description') or an announcement list screen (such as announcements and

combat reports) then append a marked-down version of this text to the

target file (for easy pasting on reddit for example).

Previous entries in the file are not overwritten, so you

may use the 'markdown' command multiple times to create a single

document containing the text from multiple screens (eg: text screens

from several dwarves, or text screens from multiple artifacts/items,

or some combination).

usage:

markdown [/n] [filename]

/n - overwrites contents of output file

filename - if provided, the data will be saved in md_filename.md instead

of default md_export.md

known screens:

The screens which have been tested and known to function properly with

this script are:

1: dwarf/unit 'thoughts' screen

2: item/art 'description' screen

3: individual 'historical item/figure' screens

4: manual

4: announements screen

5: combat reports screen

6: latest news (when meeting with liaison)

There may be other screens to which the script applies. It should be

safe to attempt running the script with any screen active, with an

error message to inform you when the selected screen is not appropriate

for this script.

target file:

The default target file's name is 'md_export.md'. A remider to this effect

will be displayed if the script is successful.

character encoding:

The text will likely be using system-default encoding, and as such

will likely NOT display special characters (eg:é,õ,ç) correctly. To

fix this, you need to modify the character set that you are reading

the document with. 'Notepad++' is a freely available program which

can do this using the following steps:

1: open the document in Notepad++

2: in the menu-bar, select

Encoding->Character Sets->Western European->OEM-US

3: copy the text normally to wherever you want to use it

]])

return

end

local writemode = 'a'

-- check if we want to append to an existing file (default) or overwrite previous contents

if args[1] == '/n' then

writemode = 'w'

table.remove(args, 1)

end

local filename

if args[1] ~= nil then

filename = 'md_' .. table.remove(args, 1) .. '.md'

else

filename = 'md_export.md'

end

local utils = require 'utils'

local gui = require 'gui'

local dialog = require 'gui.dialogs'

local scrn = dfhack.gui.getCurViewscreen()

local flerb = dfhack.gui.getFocusString(scrn)

local months = {

[1] = 'Granite',

[2] = 'Slate',

[3] = 'Felsite',

[4] = 'Hematite',

[5] = 'Malachite',

[6] = 'Galena',

[7] = 'Limestone',

[8] = 'Sandstone',

[9] = 'Timber',

[10] = 'Moonstone',

[11] = 'Opal',

[12] = 'Obsidian',

}

local function getFileHandle()

return io.open(filename, writemode)

end

local function closeFileHandle(handle)

handle:write('\n***\n\n')

handle:close()

print ('Data exported to "' .. filename .. '"')

end

local function reformat(strin)

local strout = strin

-- [P] tags seem to indicate a new paragraph

local newline_idx = string.find(strout, '[P]', 1, true)

while newline_idx ~= nil do

strout = string.sub(strout, 1, newline_idx - 1) .. '\n***\n\n' .. string.sub(strout, newline_idx + 3)

newline_idx = string.find(strout, '[P]', 1, true)

end

-- [R] tags seem to indicate a new 'section'. Let's mark it with a horizontal line.

newline_idx = string.find(strout, '[R]', 1, true)

while newline_idx ~= nil do

strout = string.sub(strout, 1, newline_idx - 1) .. '\n***\n\n' .. string.sub(strout,newline_idx + 3)

newline_idx = string.find(strout, '[R]', 1, true)

end

-- No idea what [B] tags might indicate. Just removing them seems to work fine

newline_idx = string.find(strout, '[B]', 1, true)

while newline_idx ~= nil do

strout = string.sub(strout, 1, newline_idx - 1) .. string.sub(strout,newline_idx + 3)

newline_idx = string.find(strout, '[B]', 1, true)

end

-- Reddit doesn't support custom colors in markdown. We need to remove all color information :(

local color_idx = string.find(strout, '[C:', 1, true)

while color_idx ~= nil do

strout = string.sub(strout, 1, color_idx - 1) .. string.sub(strout, color_idx + 9)

color_idx = string.find(strout, '[C:', 1, true)

end

return strout

end

local function formattime(year, ticks)

-- Dwarf Mode month is 33600 ticks long

local month = math.floor(ticks / 33600)

local dayRemainder = ticks - month * 33600

-- Dwarf Mode day is 1200 ticks long

local day = math.floor(dayRemainder / 1200)

local timeRemainder = dayRemainder - day * 1200

-- Assuming a 24h day each Dwarf Mode tick corresponds to 72 seconds

local seconds = timeRemainder * 72

local H = string.format("%02.f", math.floor(seconds / 3600));

local m = string.format("%02.f", math.floor(seconds / 60 - (H * 60)));

local i = string.format("%02.f", math.floor(seconds - H * 3600 - m * 60));

day = day + 1

if (day == 1 or day == 21) then

day = day .. 'st'

elseif (day == 2 or day == 22) then

day = day .. 'nd'

else

day = day .. 'th'

end

return (day .. " " .. months[month + 1] .. " " .. year .. " " .. H .. ":" .. m..":" .. i)

end

if flerb == 'textviewer' then

local lines = scrn.src_text

if lines ~= nil then

local log = getFileHandle()

log:write('### ' .. scrn.title .. '\n')

print('Exporting ' .. scrn.title .. '\n')

for n,x in ipairs(lines) do

log:write(reformat(x.value).." ")

-- debug output

-- print(x.value)

end

closeFileHandle(log)

end

elseif flerb == 'announcelist' then

local lines = scrn.reports

if lines ~= nil then

local log = getFileHandle()

local lastTime = ""

for n,x in ipairs(lines) do

local currentTime = formattime(x.year, x.time)

if (currentTime ~= lastTime) then

lastTime = currentTime

log:write('\n***\n\n')

log:write('## ' .. currentTime .. '\n')

end

-- debug output

-- print(x.text)

log:write(x.text .. '\n')

end

closeFileHandle(log)

end

elseif flerb == 'topicmeeting' then

local lines = scrn.text

if lines ~= nil then

local log = getFileHandle()

for n,x in ipairs(lines) do

-- debug output

-- print(x.value)

log:write(x.value .. '\n')

end

closeFileHandle(log)

end

else

print 'This is not a textview, announcelist or topicmeeting screen. Can\'t export data, sorry.'

end