summaryrefslogtreecommitdiff
path: root/autodoc/source/exes/adc_uni/spec-SinceTag_Handling.txt
blob: 7cf264e76be32e11a0d8ed4ba0f45784dbaf70c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
		General Handling
		----------------

- The developer inserts the OpenOffice.org version into the @since tag.

- @since-Tag may contain any string which needs to end with a Version number.
  The first cipher following immediately on a white space is interpreted as start of the version number.

- The @since Tag must stay completely within one line to allow tool support for retargeting.

- To replace @since entries in the generated documentation, one needs to use
  the command line option

  -sincefile <TransformationFile-path>

  This option has to occur immediately after the -html option.
  If this option is not given, the original text of the @since tag is
  displayed.

  If the TransformationFile does not contain a specific entry,
  nothing is displayed for this entry.



		Format of the @since Tag Transformation File
		--------------------------------------------

Example
-------

***** BEGIN OF FILE ******
"1.1" "StarOffice 7.0"
"2.0" "StarOffice 8.0"
"2.1" "StarOffice 9.0"
***** END OF FILE ******



Rules and Restrictions
----------------------

*	Each line contains two strings within "".
	The first string is the OpenOffice.org version number which is found in the @since tag.
	The second string is the string to display for this version.
*	No specific order among product versions is needed.
*	Empty lines and whitespaces are allowed, except:
	- Non empty lines must not start with white space.
	- Within OpenOffice.org version strings, no whitespace is allowed.
*	Whitespace within display strings is displayed as it is.