/
main.gs
170 lines (144 loc) · 4.62 KB
/
main.gs
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
/**
* Runs when the add-on is installed.
* This method is only used by the regular add-on, and is never called by
* the mobile add-on version.
*
* @param {object} e The event parameter for a simple onInstall trigger. To
* determine which authorization mode (ScriptApp.AuthMode) the trigger is
* running in, inspect e.authMode. (In practice, onInstall triggers always
* run in AuthMode.FULL, but onOpen triggers may be AuthMode.LIMITED or
* AuthMode.NONE.)
*/
function onInstall(e) {
onOpen(e);
}
/**
* Creates a menu entry in the Google Docs UI when the document is opened.
* This method is only used by the regular add-on, and is never called by
* the mobile add-on version.
*
* @param {object} e The event parameter for a simple onOpen trigger. To
* determine which authorization mode (ScriptApp.AuthMode) the trigger is
* running in, inspect e.authMode.
*/
function onOpen(e) {
DocumentApp.getUi()
.createAddonMenu()
.addItem('Auto-number headings', 'updateHeadings')
.addSeparator()
.addItem('Update references', 'updateReference')
.addItem('Remove references', 'removeReference')
.addSeparator()
.addItem('Help', 'getHelp')
.addToUi();
}
/**
* update all reference and auto number automatically
* reference include: heading, figure, and table
*
* @param
* .
* @returns
*/
function updateReference() {
// get all link objs
var links = getAllBookmarkLinks(DocumentApp.getActiveDocument().getBody(), 1);
// get bookmark objs
var bookmarkObjs = getBookmarkObjs(links);
Logger.log(bookmarkObjs);
// check error
if (bookmarkObjs === 'error') {
return 'error';
}
// get paragraph map
var paragraphMap = getParagraphMap(links);
// get bookmark map
var bookmarkMap = getBookmarkMap(bookmarkObjs);
// remove all bookmark - this has to be done on ALL bookmarks; otherwise odd errors would occur
for (var i = 0; i < bookmarkObjs.length; i++) {
bookmarkObjs[i].bookmark.remove();
}
// prepare for auto number
var figureNumber = 0;
var tableNumber = 0;
for (var i = 0; i < bookmarkObjs.length; i++) {
var bookmarkObj = bookmarkObjs[i];
if (bookmarkObj.type == 'heading') {
updateHeadingReference(bookmarkObj, bookmarkObjs, paragraphMap, bookmarkMap);
} else if (bookmarkObj.type == 'figure') {
figureNumber++;
updateFigureReference(bookmarkObj, figureNumber, bookmarkObjs, paragraphMap, bookmarkMap);
} else if (bookmarkObj.type == 'table') {
tableNumber++;
updateTableReference(bookmarkObj, tableNumber, bookmarkObjs, paragraphMap, bookmarkMap);
} else {
updateOtherReference(bookmarkObj, bookmarkObjs, paragraphMap, bookmarkMap);
}
}
}
/**
* remove all references.
* reference include: heading, figure, and table
*
* @param
* .
* @returns
*/
function removeReference() {
// get all link objs
var links = getAllBookmarkLinks(DocumentApp.getActiveDocument().getBody(), 1);
// get bookmark objs
var bookmarkObjs = getBookmarkObjs(links);
// check error
if (bookmarkObjs === 'error') {
return 'error';
}
for (var i = 0; i < bookmarkObjs.length; i++) {
var bookmarkObj = bookmarkObjs[i];
if (bookmarkObj.type == 'heading' || bookmarkObj.type == 'figure' || bookmarkObj.type == 'table') {
// remove the bookmark
bookmarkObj.bookmark.remove();
// remove references to the bookmark
for (var [parKey, linkObj] of bookmarkObj.linkMap.entries()) {
linkObj.paraTextObj.setLinkUrl(linkObj.start, linkObj.end, '');
}
}
}
}
/**
* auto-number heading bookmarks.
* dealing with the scenario when section titles have been referenced using bookmarks before auto-numbering
*
* @param
* .
* @returns
*/
function updateHeadings() {
// get all link objs
var links = getAllBookmarkLinks(DocumentApp.getActiveDocument().getBody(), 1);
// get bookmark objs
var bookmarkObjs = getBookmarkObjs(links);
// check error
if (bookmarkObjs === 'error') {
return 'error';
}
// get paragraph map
var paragraphMap = getParagraphMap(links);
// get bookmark map
var bookmarkMap = getBookmarkMap(bookmarkObjs);
// filter to just heading bookmarks
var headingObjs = bookmarkObjs.filter(function getOther(bookmarkOjb) {
if (bookmarkOjb.type === 'heading') { return true; }
else { return false; }
});
// remove heading bookmarks
for (var i = 0; i < headingObjs.length; i++) {
headingObjs[i].bookmark.remove();
}
// auto-number headings
numberHeadings();
// update heading bookmarks
for (var i = 0; i < headingObjs.length; i++) {
updateHeadingReference(headingObjs[i], bookmarkObjs, paragraphMap, bookmarkMap);
}
}