version 2, including all changes.
.
Rev |
Author |
# |
Line |
1 |
perry |
1 |
SCROLLKEEPER-UPDATE |
|
|
2 |
!!!SCROLLKEEPER-UPDATE |
|
|
3 |
NAME |
|
|
4 |
SYNOPSIS |
|
|
5 |
DESCRIPTION |
|
|
6 |
AUTHOR |
|
|
7 |
SEE ALSO |
|
|
8 |
---- |
|
|
9 |
!!NAME |
|
|
10 |
|
|
|
11 |
|
|
|
12 |
scrollkeeper-gen-seriesid - generate a unique id for a document series for use in an OMF metadata file |
|
|
13 |
!!SYNOPSIS |
|
|
14 |
|
|
|
15 |
|
|
|
16 |
__scrollkeeper-gen-seriesid__ |
|
|
17 |
!!DESCRIPTION |
|
|
18 |
|
|
|
19 |
|
|
|
20 |
This generates a unique id for use as the __seriesid__ |
|
|
21 |
attribute to the __relation__ element in the OMF |
|
|
22 |
metadata. This id is referred to as the |
|
|
23 |
__ |
|
|
24 |
|
|
|
25 |
|
|
|
26 |
The seriesid is used to specify a group (or series) of |
|
|
27 |
documents which are related. For example, multiple versions, |
|
|
28 |
formats, and translations of a single document are |
|
|
29 |
considered to be in the same series. Thus, any new version, |
|
|
30 |
translation, etc. of a pre-existing document should inherit |
|
|
31 |
the seriesid of the original document. Only document series |
|
|
32 |
which have never been assigned a seriesid in the past should |
|
|
33 |
use __scrollkeeper-gen-seriesid__ to obtain a new |
|
|
34 |
seriesid. |
|
|
35 |
|
|
|
36 |
|
2 |
perry |
37 |
!ScrollKeeper uses the seriesid of documents to identify |
1 |
perry |
38 |
which documents are related to each other. For example, when |
2 |
perry |
39 |
creating the contents list, !ScrollKeeper must identify if |
1 |
perry |
40 |
two documents are in the same series in order to display the |
|
|
41 |
most complete set of documents on the system, using locale |
|
|
42 |
fallback for documents which may not be translated into a |
|
|
43 |
given locale, without displaying the same document in two |
|
|
44 |
locales. |
|
|
45 |
!!AUTHOR |
|
|
46 |
|
|
|
47 |
|
|
|
48 |
Laszlo Kovacs |
|
|
49 |
Dan Mueth |
|
|
50 |
!!SEE ALSO |
|
|
51 |
|
|
|
52 |
|
|
|
53 |
scrollkeeper-config(1), scrollkeeper.conf(5), |
|
|
54 |
scrollkeeper(7), scrollkeeper-preinstall(8), |
|
|
55 |
scrollkeeper-rebuilddb(8), |
|
|
56 |
scrollkeeper-update(8) |
|
|
57 |
---- |