Skip to content

Commit 4585cd6

Browse files
committed
Correct some schema comments
1 parent 8cd602c commit 4585cd6

1 file changed

Lines changed: 12 additions & 15 deletions

File tree

src/docbuild/config/xml/data/portal-config-schema.rnc

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# RELAX NG Schema for Docserv² product configuration
1+
# RELAX NG Schema for portal product configuration
22
namespace a = "http://relaxng.org/ns/compatibility/annotations/1.0"
33
namespace db = "http://docbook.org/ns/docbook"
44
namespace xi = "http://www.w3.org/2001/XInclude"
@@ -94,8 +94,6 @@ div {
9494
}
9595

9696

97-
98-
9997
# CONSTANTS
10098

10199
# Whenever there is a backward-incompatible schema revision, bump this
@@ -212,7 +210,6 @@ ds.type.id =
212210

213211
ds.type.idmulti =
214212
## A space-separated list of IDs
215-
# (we do not check via RNC -- we check in docserv-stitch)
216213
[
217214
db:refpurpose [ "A space-separated list of IDs" ]
218215
]
@@ -249,7 +246,7 @@ ds.type.hexdigest =
249246
# exactly this way or in this order, just that, if available, all of the
250247
# information requested will come out.
251248
ds.type.titleformat.build =
252-
## Elements of titles displayed on navigational pages for documents built within Docserv²
249+
## Elements of titles displayed on navigational pages for documents built within the portal
253250
"title" | "title docset" | "title product" | "title subtitle" | "title subtitle product" | "title subtitle docset"
254251
# For external links, some metadata is never available: product name and
255252
# subtitle cannot be generated in any way currently (but you're free to
@@ -381,7 +378,7 @@ ds.titleformat.attr =
381378
## How to display the document title on the product version navigational page, a combination of the following values:
382379
## * `title`: title as extracted from the document
383380
## * `subtitle`: subtitle as extracted from the document (can be empty)
384-
## * `docset`: product and version number as classified in the Docserv² product configuration
381+
## * `docset`: product and version number as classified in the portal product configuration
385382
## * `product`: product and version number as extracted from the document (can be empty)
386383
## Note the following:
387384
## * `title` is mandatory
@@ -521,9 +518,9 @@ div {
521518
ds.id.attr
522519

523520
ds.schemaversion.attr =
524-
## Version of the schema, verifies that Docserv² major version and version of product configuration match
521+
## Version of the schema, verifies that portal schema major version and version of product configuration match
525522
[
526-
db:refpurpose [ "Version of the schema, verifies that Docserv² major version and version of product configuration match" ]
523+
db:refpurpose [ "Version of the schema, verifies that portal schema major version and version of product configuration match" ]
527524
]
528525
# TODO: Simplify to version?
529526
attribute schemaversion { ds.schema.version }
@@ -1086,11 +1083,11 @@ ds.partners =
10861083

10871084
[
10881085
db:refname [ "deliverable" ]
1089-
db:refpurpose [ "Definition of an individual DAPS-compatible document built on its own (default language)" ]
1086+
db:refpurpose [ "Definition of an individual document (default language)" ]
10901087
]
10911088
div {
10921089
ds.deliverable =
1093-
## An individual DAPS-compatible document built on its own (default language)
1090+
## An individual document (default language)
10941091
element deliverable {
10951092
ds.remarks.attr?,
10961093
ds.draft.attr?,
@@ -1194,11 +1191,11 @@ ds.subdeliverable =
11941191

11951192
[
11961193
db:refname [ "internal" ]
1197-
db:refpurpose [ "Container for Docserv²-internal references" ]
1194+
db:refpurpose [ "Wrapper for internal references" ]
11981195
]
11991196
div {
12001197
ds.internal =
1201-
## Container for Docserv²-internal references
1198+
## Wrapper for internal references
12021199
element internal {
12031200
ds.ref+
12041201
}
@@ -1207,7 +1204,7 @@ ds.internal =
12071204

12081205
[
12091206
db:refname [ "ref" ]
1210-
db:refpurpose [ "Reference to a document or navigational page within Docserv²" ]
1207+
db:refpurpose [ "Reference to a document or navigational page" ]
12111208
]
12121209
div {
12131210
# The following definition is a bit complicated, so -- the intention is to
@@ -1255,7 +1252,7 @@ div {
12551252

12561253

12571254
ds.ref =
1258-
## Docserv²-internal reference
1255+
## Internal reference
12591256
element ref {
12601257
ds.product.attr,
12611258
(
@@ -1303,7 +1300,7 @@ ds.link =
13031300
ds.category.attr?,
13041301
## How to display the document title on the product version navigational page, a combination of the following values:
13051302
## * `title`: title as extracted from the document
1306-
## * `docset`: product and version number as classified in the Docserv² product configuration
1303+
## * `docset`: product and version number as classified in the portal product configuration
13071304
## Note the following:
13081305
## * `title` is mandatory
13091306
## * the order of values must be `title`, `docset`

0 commit comments

Comments
 (0)