Repository navigation
Commit 4d0b073
committed
docs: build the Word editions from a plain template with absolute links
The Word editions of the specifications carried the O-RAN logo, the
O-RAN ALLIANCE copyright, a working group on the cover and a Foreword
and Modal verbs clause that named O-RAN. They are not O-RAN ALLIANCE
documents, so tools/oran_docx now builds an O-RAN-like edition: the
layout of an O-RAN Technical Specification, the front matter of libe3.
* template.docx has no logo, no working group and no rule across the
cover. The copyright page names Northeastern University and the
Apache License 2.0, the footers carry only the page number at the
right margin, the Foreword says who produced the document and the
Modal verbs clause refers to the ETSI Drafting Rules. The unused
logo and the KPM figure left over from the cut are gone.
* make_template.py writes that front matter as part of making the
template from the O-RAN specification. The docx.json field group
and DEFAULT_GROUP of build_docx.py are gone, with the E2SM-DAPP
override.
* build_docx.py writes the document number into the TitlesOfParts
property, which still held the placeholder of the O-RAN template.
* The Scope of each specification says that the document is generated
from the codebase and protocol definitions of libe3.
The Word edition has no files to link to, so build_docx.py turns each
link into a reference a reader can follow: a link to a part of the
same specification becomes its clause ("clause 8", "Annex A", "clause
6.2" with an anchor), any other link an absolute GitHub URL, and the
sentence "The index is README.md." is left out. The Markdown edition
keeps its relative links. The references to the other specifications
of the series give their document number, title and GitHub folder,
the E2GAP reference has one spelling, a plain "see 02" in E2SM-DAPP
is a link, and the Spectrum note on hyperlinks no longer names O-RAN.
The four Word editions are rebuilt in the container.
Assisted-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>1 parent 42ee5a5 commit 4d0b073
14 files changed
Lines changed: 324 additions & 90 deletions
File tree
- docs
- e2sm-dapp
- e3ap
- e3sm
- l1-kpm
- spectrum
- tools/oran_docx
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | | - | |
| 46 | + | |
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
| |||
Binary file not shown.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
29 | 32 | | |
30 | 33 | | |
31 | 34 | | |
| |||
37 | 40 | | |
38 | 41 | | |
39 | 42 | | |
40 | | - | |
| 43 | + | |
41 | 44 | | |
42 | 45 | | |
43 | 46 | | |
| |||
49 | 52 | | |
50 | 53 | | |
51 | 54 | | |
52 | | - | |
| 55 | + | |
53 | 56 | | |
54 | 57 | | |
55 | 58 | | |
56 | 59 | | |
57 | 60 | | |
58 | 61 | | |
59 | | - | |
60 | | - | |
| 62 | + | |
| 63 | + | |
61 | 64 | | |
62 | 65 | | |
63 | 66 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
6 | 5 | | |
7 | 6 | | |
8 | 7 | | |
| |||
Binary file not shown.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
22 | 25 | | |
23 | 26 | | |
24 | 27 | | |
| |||
43 | 46 | | |
44 | 47 | | |
45 | 48 | | |
46 | | - | |
| 49 | + | |
47 | 50 | | |
48 | | - | |
| 51 | + | |
49 | 52 | | |
50 | 53 | | |
51 | 54 | | |
| |||
Binary file not shown.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
47 | 50 | | |
48 | 51 | | |
49 | 52 | | |
| |||
53 | 56 | | |
54 | 57 | | |
55 | 58 | | |
56 | | - | |
| 59 | + | |
57 | 60 | | |
58 | 61 | | |
59 | 62 | | |
| |||
Binary file not shown.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
36 | 39 | | |
37 | 40 | | |
38 | 41 | | |
| |||
43 | 46 | | |
44 | 47 | | |
45 | 48 | | |
46 | | - | |
| 49 | + | |
47 | 50 | | |
48 | 51 | | |
49 | 52 | | |
50 | 53 | | |
51 | | - | |
| 54 | + | |
52 | 55 | | |
53 | 56 | | |
54 | 57 | | |
| |||
0 commit comments