[an error occurred while processing this directive]
[an error occurred while processing this directive]
[an error occurred while processing this directive]
Help for DocumentAddForm
[an error occurred while processing this directive]
[an error occurred while processing this directive]
[an error occurred while processing this directive]
DocumentAddForm generates, based on a number of input parameters, the forms
used to Reserve, Add, or Update documents and the form used to update the
database information about a document.
Reading through the code to figure out what all the input variables do can be a
little difficult, so this guide is offered for those who might like to construct
custom links to DocumentAddForm. These links should be of the form
http://www-btev.fnal.gov/cgi-bin/DocDB/DocumentAddForm?param1=value1¶m2=value2...
These parameters are most likely to be of interest:
- mode
- The most important setting, for example &mode=add. Possible
values:
- reserve
- Used to reserve a new document, but not upload the actual document. No
upload field is supplied, the created version number is 0, and most selections
are optional.
- add
- Used to add a brand new document. By default, one upload field is
supplied. The created version number is 1, and only a few selections
are optional.
- update
- Used to update an existing document. The number of upload fields provided
by default matches the number of files in the latest version of the document.
The version number is incremented by one. All the selections except files are
pre-filled to the values from the latest version of the document. The
docid parameter must also be supplied.
- updatedb
- Used to update only the information about an existing document, not the
document itself. No upload field is supplied. The version number is not
incremented. All the selections are pre-filled to the values from the latest
version of the document. The user need only change the information they wish
to. The docid parameter must also be supplied.
- docid
- The number of the document to be modified under the update or
updatedb options above. (For example
mode=update&docid=140 will bring up a form to update
BTeV-doc-140.)
- pretopic
- Used to supply one more more topics by MinorTopicIDs which are selected
automatically in the form. This is intended to make entering documents for
sub-groups or for meetings that aren't collaboration meetings a little easier
for non-experts by following links that give pre-filled forms. (For example
&pretopic=45&pretopic=25 will preselect two topics.)
- special
- Activates a special mode of document entry, for example special=meeting. Possible values are:
- meeting
- Used for entering group meeting talks. This is a restricted mode
and also pre-selects the nearest group meeting if the meetings start date is within
$MeetingWindow days of the current date.
- othermeeting
- Like meeting but no meeting date is preselected. Still a reduced
set useful only for talks.
These parameters are probably not of as much use. They control the finer details of what
the entry form looks like.
[an error occurred while processing this directive]
[an error occurred while processing this directive]