blob: 2810343eb520d9cecbbf64f9d6fc6cb051eb5c06 (
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
|
# docs
This folder contains the project documentation in [AsciiDoc][asciidoc] format.
To compile the documents, make sure you have [Ruby][rubydl] and the
dependencies installed by running the `bundle` command in this folder. A
makefile is provided for convenience.
## notes for writers
- "I<sup>2</sup>C" is written as `I^2^C`
- "C++" is written as `{cpp}`
- please give cross references, links, image files, figure ids, etc. meaningful
names
## TODO
- transfer documents
- [x] project plan
- [x] requirements
- [x] research
- [ ] footnotes
- [ ] software design
- [ ] footnotes
- xrefs for--
- [x] tables
- [x] figures
- [x] section numbers (headings)
- [x] requirements
- [x] figures
- [x] citations
- [ ] table of tables
- [ ] table of figures
- [ ] glossary (w/ cross-references)
- [ ] PDF style
- [ ] give used requirements more meaningful id's
## for later reference
### get citation keys from .docx file
```
$ unar file.docx
$ grep -o 'CITATION[^<]\+' file/word/document.xml | awk '!x[$2]++ { i++; print "[" i "] " $2 }'
```
[rubydl]: https://www.ruby-lang.org/en/documentation/installation/
[asciidoc]: https://asciidoc.org/
|