Skip to content

Commit 3e7779f

Browse files
committed
Updating document tree in README to reflect current build structure.
1 parent 4278db8 commit 3e7779f

File tree

1 file changed

+36
-32
lines changed

1 file changed

+36
-32
lines changed

tg2/_make_review/README.md

Lines changed: 36 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ This directory \_make_review.
3131
_make_review
3232
├── copy_files.sh Copies files from the source tree to the target tree. **Editable.**
3333
├── do_build.sh Runs the build scripts in the _build_review directory. **Editable.**
34-
├── README.md This file. **Editable.**
35-
└── requirements.txt Python libraries required to run the build scripts. **Editable.**
34+
└── README.md This file. **Editable.**
3635
</pre>
3736

3837
## The Source directory for the build: \_build_review
@@ -49,45 +48,50 @@ Most of these files are generated by the build scripts in the _build_review dire
4948
Summary of files in the tg2/\_review directory:
5049

5150
<pre>
52-
├── README.md Introduction for public review of th draft **Editable.**
51+
_review/
52+
├── README.md Introduction for public review of the draft **Editable.**
5353
├── index.md Landing page for the standard. **Editable.** (the references are embedded in this file)
54+
├── workflow_single_iteration.svg image file used in index.md, **Editable.**
55+
├── workflow_two_iterations.svg image file used in index.md, **Editable.**
5456
├── dist Generated CSV distribution files for building other artifacts.
5557
│ ├── bdq.xml Generated RDF for bdq vocabulary (built with draft_build-termlist.py).
56-
│ ├── bdqcore.json JSON serialization of the RDF representation of test descriptions, built by kurator-ffdq from bdq/tg2/core/TG2_tests.csv as bdq/tg2/core/TG2_tests.ttl.
57-
│ ├── bdqcore.ttl Turtle serialization of the RDF representation of test descriptions, built by kurator-ffdq from bdq/tg2/core/TG2_tests.csv as bdq/tg2/core/TG2_tests.ttl.
58-
│ ├── bdqcore.xml RDF/XML serialization of the RDF representation of test descriptions, built by kurator-ffdq from bdq/tg2/core/TG2_tests.csv as bdq/tg2/core/TG2_tests.xml.
59-
│ ├── bdqcore_singlerecord_tests_current.csv CSV list of current bdqcore SingleRecord tests, for the convenience of implementers. Produced by _make_review/copy_files.sh
60-
│ ├── bdqtest_multirecord_tests_current.csv CSV list of current bdqcore MultiRecord tests, for the convenience of implementers. Produced by _make_review/copy_files.sh
61-
│ ├── bdqcore_tests_vertical.csv List of test label, prefLabel, and fully qualified name.
58+
│ ├── bdqtest.json JSON serialization of the RDF representation of test descriptions, built by kurator-ffdq from bdq/tg2/core/TG2_tests.csv as bdq/tg2/core/TG2_tests.ttl.
59+
│ ├── bdqtest.ttl Turtle serialization of the RDF representation of test descriptions, built by kurator-ffdq from bdq/tg2/core/TG2_tests.csv as bdq/tg2/core/TG2_tests.ttl.
60+
│ ├── bdqtest.xml RDF/XML serialization of the RDF representation of test descriptions, built by kurator-ffdq from bdq/tg2/core/TG2_tests.csv as bdq/tg2/core/TG2_tests.xml.
61+
│ ├── bdqtest_singlerecord_tests_current.csv CSV list of current bdqtest SingleRecord tests, for the convenience of implementers. Produced by _make_review/copy_files.sh
62+
│ ├── bdqtest_multirecord_tests_current.csv CSV list of current bdqtest MultiRecord tests, for the convenience of implementers. Produced by _make_review/copy_files.sh
63+
│ ├── bdqtest_tests_vertical.csv List of test label, prefLabel, and fully qualified name.
6264
│ ├── bdqcrit.xml Generated RDF for bdqcrit vocabulary (built with draft_build-termlist.py).
6365
│ ├── bdqdim.xml Generated RDF for bdqdim vocabulary (built with draft_build-termlist.py).
6466
│ └── bdqenh.xml Generated RDF for bdqenh vocabulary (built with draft_build-termlist.py).
6567
├── docs Human-readable documentation files built from files in build directory.
66-
│ ├── bdqcore Landing page for bdqcore, with normative statements.
68+
│ ├── bdqtest Landing page for bdqtest, with normative statements.
6769
│ │ └── index.md Generated file. **Do not edit.**
6870
│ ├── bdqffdq Landing page for bdqffdq, with normative statements.
6971
│ │ └── index.md Generated file. **Do not edit.**
7072
│ ├── extension Build targets for Human readable vocabulary extension documents.
7173
│ │ └── bdqffdq
72-
│ │ └── index.md Generated extension document. **Do not edit.**
74+
│ │ └── index.md Generated vocabulary extension document. **Do not edit.**
7375
│ ├── guide Descriptive document build targets.
74-
│ │ ├── bdqffdq
76+
│ │ ├── bdqffdq The guide to bdqffdq
7577
│ │ │ ├── *.svg and *.png Files copied here from _build_review. **Do not edit.**
7678
│ │ │ └── index.md Generated file. **Do not edit.**
77-
│ │ ├── implementers
79+
│ │ ├── implementers The implementers guide
7880
│ │ │ ├── index.md Generated file. **Do not edit.**
7981
│ │ │ ├── TG2_test_validation_data_nonprintingchars.csv **Do not edit.**
8082
│ │ │ └── TG2_test_validation_data.csv **Do not edit.**
81-
│ │ └── users
82-
│ │ └── index.md Generated file. **Do not edit.**
83+
│ │ ├─ users The users guide
84+
│ │ │ └── index.md Generated file. **Do not edit.**
85+
│ │ └── synthetic The guide to marking synthetic data
86+
│ │ └── index.md Generated file. **Do not edit.**
8387
│ ├── intro Generated Introduction to the standard.
8488
│ │ ├── index.md Generated file. **Do not edit.**
8589
│ │ └── *.svg Files copied here from build. **Do not edit.**
8690
│ ├── list Build targets for Human readable term list documents. **Do not edit.**
8791
│ │ ├── bdq
8892
│ │ │ └── index.md Generated bdq term list document. **Do not edit.**
89-
│ │ ├── bdqcore
90-
│ │ │ └── index.md Generated bdqcore term list document. **Do not edit.**
93+
│ │ ├── bdqtest
94+
│ │ │ └── index.md Generated bdqtest term list document. **Do not edit.**
9195
│ │ ├── bdqcrit
9296
│ │ │ └── index.md Generated bdqcrit term list document. **Do not edit.**
9397
│ │ ├── bdqdim
@@ -97,25 +101,21 @@ Summary of files in the tg2/\_review directory:
97101
│ │ └── bdqffdq
98102
│ │ └── index.md Generated bdqffdq term list document. **Do not edit.**
99103
│ ├── supplement
100-
│ │ ── index.md Generated file. **Do not edit.**
104+
│ │ ── index.md Generated file. **Do not edit.**
101105
│ │ └── *.png Files copied here from build. **Do not edit.**
102-
│ ├── synthetic
103-
│ │ └── index.md Generated file. **Do not edit.**
104-
│ ├── terms Build targets for Quick Reference Guides.
105-
│ │ └── bdqcore
106-
│ │ ├── bdqcore_qrg_term_descriptions.md Terms key for index.md. Generated file. **Do not edit.**
107-
│ │ ├── index.md Generated file. **Do not edit.**
108-
│ │ ├── qrg_index_by_dimension.md Generated file. **Do not edit.**
109-
│ │ ├── qrg_index_by_ie_actedupon.md Generated file. **Do not edit.**
110-
│ │ ├── qrg_index_by_ie_class.md Generated file. **Do not edit.**
111-
│ │ ├── qrg_index_by_usecase.md Generated file. **Do not edit.**
112-
│ │ └── qrg_multirecord_index.md Generated file. **Do not edit.**
113-
│ └── vocabularies
114-
│ └── index.md Generated file. **Do not edit.**
106+
│ └── terms Build targets for Quick Reference Guides.
107+
│ └── bdqtest Quick reference guide to the tests
108+
│ ├── bdqtest_qrg_term_descriptions.md Terms key for index.md. Generated file. **Do not edit.**
109+
│ ├── index.md Generated file. **Do not edit.**
110+
│ ├── index.html Generated file. Proof of concept html rendering of the QRG deployed at https://tdwg.github.io/bdq/terms/bdqtest/ **Do not edit.**
111+
│ ├── qrg_index_by_dimension.md Generated file. **Do not edit.**
112+
│ ├── qrg_index_by_ie_actedupon.md Generated file. **Do not edit.**
113+
│ ├── qrg_index_by_ie_class.md Generated file. **Do not edit.**
114+
│ ├── qrg_index_by_usecase.md Generated file. **Do not edit.**
115+
│ └── qrg_multirecord_index.md Generated file. **Do not edit.**
115116
└── vocabulary Master copies of vocabularies as term version files (and an OWL file).
116117
├── README.md list, description, and editable state of the vocabulary files
117118
├── bdq_term_versions.csv Term version file for `bdq:` supplemental vocabulary. **Editable.**
118-
├── bdqcore_term_versions.csv Term version file for `bdqcore:` Core vocabulary. **Editable.**
119119
├── bdqcrit_term_versions.csv Term version file for `bdqcrit:` Criterion vocabulary. **Editable.**
120120
├── bdqdim_term_versions.csv Term version file for `bdqdim:` Dimension vocabulary. **Editable.**
121121
├── bdqenh_term_versions.csv Term version file for `bdqenh:` Enhancement vocabulary. **Editable.**
@@ -124,6 +124,10 @@ Summary of files in the tg2/\_review directory:
124124
Note: Current master files for the tests are: tg2/core/TG2_tests.csv and tg2/core/TG2_multirecord_measure_tests.csv
125125
</pre>
126126

127+
# Build file for proof of concept html representation of the quick reference guide
128+
129+
tg2/\_build_html/generate_bdq_qrg.py
130+
127131
# Suggestions for a maintenance group tg2/maintenance
128132

129133
<pre>

0 commit comments

Comments
 (0)