Skip to content

Commit ab1b296

Browse files
committed
update vignette
1 parent d073f5f commit ab1b296

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

vignettes/writing_templates_and_data_guides.Rmd

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,20 +102,31 @@ will be interpreted as having a minor version <kbd>0</kbd>, *i.e.* a version
102102
"<kbd>2</kbd>" will be interpreted as "<kbd>2.0</kbd>".
103103

104104
In practice this means that the format of the cell in which the version number
105-
is recorded should be *text*, and not *general* or *number*
105+
is recorded should formally be *text*, and not *general* or *number*. However,
106+
in the package we do provide functionality to interpret these fields as version
107+
numbers even if the cells in the template have *general* or *number* format.
106108

107-
**A template name is optional**. Preferably, a template also has a name. Note
108-
that the example in the figure above doesn't have a name.
109+
In the guide this is referred to as <kbd>guide.version</kbd>
110+
111+
**A template name is optional**. Preferably, a template also has a name as a way
112+
for users to refer to it. Note that the example in the figure above doesn't
113+
have a name.
114+
115+
In the guide this field is referred to as <kbd>template.name</kbd>.
109116

110117
**Checking compatibilty of template versions and a guide version**. We use
111118
template version numbers to check compatibility with a guide. In principle
112119
the same guide can be used for multiple versions of a template as long as the
113-
locations and names of variables indexed in the guide did not change. This is the
114-
case when, for example, only explanatory texts or calculations or data validity
120+
locations and names of variables indexed in the guide did not change in new
121+
template versions. This is the case when, for example, only explanatory texts
122+
or calculations or data validity
115123
checks have changed in the template. When checking version compatibility we
116124
assume that a guide is compatible with a consecutive range of template versions
117125
between a minimal and a maximal version number.
118126

127+
In the guide these version numbers are referred to as <kbd>template.min.version</kbd>
128+
and <kbd>template.max.version</kbd>.
129+
119130
### All cells are protected except those for data entry
120131

121132
Data entry cells have a distinct background color, here "marker yellow". All

0 commit comments

Comments
 (0)