From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/docbuilder/doc/src/header_tags.xml | 183 +++++++++++++++++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100644 lib/docbuilder/doc/src/header_tags.xml (limited to 'lib/docbuilder/doc/src/header_tags.xml') diff --git a/lib/docbuilder/doc/src/header_tags.xml b/lib/docbuilder/doc/src/header_tags.xml new file mode 100644 index 0000000000..b1456d679a --- /dev/null +++ b/lib/docbuilder/doc/src/header_tags.xml @@ -0,0 +1,183 @@ + + + + +
+ + 19972009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + Header Tags + + + + + header_tags.xml +
+ +

Each document begins with a header part, which looks the same for + all DTDs. Here the title of the document is specified, as well as + administrative data like who is responsible for the document, which + version is it, when was it last changed and such.

+ +

An full header looks like:

+ 
+<header>
+  <copyright>...</copyright>
+  <legalnotice>...</legalnotice>
+  <title>...</title>
+  <prepared>...</prepared>
+  <responsible>...</responsible>
+  <docno>...</docno>
+  <approved>...</approved>
+  <checked>...</checked>
+  <date>...</date>
+  <rev>...</rev>
+  <file>...</file>
+</header>
+
+ +
+ + <header> + +

Top level tag for the header part.

+
+ +
+ + <copyright> + +

The copyright element holds information about date(s) and holder(s) of + a document copyright. The copyright element is optional. + The copyright element has an inner structure containing one or + more + year elements followed by zero of more holder elements.
+ See example below: +

+ + 1997 + 2007 + Ericsson AB + + ]]> +
+ +
+ + <legalnotice> + +

The legalnotice element is used to express copyright, trademark, + license, and other legal formalities of a document. The element contains + only PCDATA in the same manner as code and pre. +

+
+ +
+ + <title> + +

For part and application documents, this will be + the title of the document, visible in the left frame and on + the front page.

+ +

For chapter documents, this will be the chapter name.

+ +

For reference manual documents, this tag is ignored.

+
+ +
+ <shorttitle> + +

This optional tag is ignored by DocBuilder. It will likely be + removed in the future.

+
+ +
+ + <prepared> + +

This tag is intended for administrative use and is ignored by + DocBuilder.

+
+ +
+ + <responsible> + +

This optional tag is intended for administrative use and is + ignored by DocBuilder.

+
+ +
+ + <docno> + +

Document number.

+ +

For part and application documents, the document + number is visible in the left frame and on the front page.

+ +

For other types of documents, this tag is ignored.

+
+ +
+ + <approved> + +

This optional tag is intended for administrative use and is + ignored by DocBuilder.

+
+ +
+ + <checked> + +

This optional tag is intended for administrative use and is + ignored by DocBuilder.

+
+ +
+ + <date> + +

This tag is intended for administrative use and is ignored by + DocBuilder.

+
+ +
+ + <rev> + +

Document version.

+ +

For part and application documents, the document + version is visible in the left frame and on the front page.

+ +

For other types of documents, this tag is ignored.

+
+ +
+ + <file> + +

This optional tag is intended for administrative use and is + ignored by DocBuilder.

+
+ + -- cgit v1.2.3