summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2011-02-17 19:40:38 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2011-02-17 19:40:38 (GMT)
commit2eccbfdb1a422e1ee594b1906de13d3f4a070c06 (patch)
treec2ee5bb85f9acfb3caa8479c32b49a1bf03de752 /doc
parente3867f798e35c06c2208899f9c0bc264d8e6cb83 (diff)
downloadDoxygen-2eccbfdb1a422e1ee594b1906de13d3f4a070c06.zip
Doxygen-2eccbfdb1a422e1ee594b1906de13d3f4a070c06.tar.gz
Doxygen-2eccbfdb1a422e1ee594b1906de13d3f4a070c06.tar.bz2
Release-1.7.3-20110217
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc127
-rw-r--r--doc/doxygen.12
-rw-r--r--doc/language.doc4
-rw-r--r--doc/translator_report.txt22
4 files changed, 91 insertions, 64 deletions
diff --git a/doc/config.doc b/doc/config.doc
index 8c72a23..0a3b0ce 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -161,6 +161,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_html_colorstyle_hue HTML_COLORSTYLE_HUE
\refitem cfg_html_colorstyle_sat HTML_COLORSTYLE_SAT
\refitem cfg_html_dynamic_sections HTML_DYNAMIC_SECTIONS
+\refitem cfg_html_extra_files HTML_EXTRA_FILES
\refitem cfg_html_file_extension HTML_FILE_EXTENSION
\refitem cfg_html_footer HTML_FOOTER
\refitem cfg_html_header HTML_HEADER
@@ -185,6 +186,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_javadoc_autobrief JAVADOC_AUTOBRIEF
\refitem cfg_latex_batchmode LATEX_BATCHMODE
\refitem cfg_latex_cmd_name LATEX_CMD_NAME
+\refitem cfg_latex_footer LATEX_FOOTER
\refitem cfg_latex_header LATEX_HEADER
\refitem cfg_latex_hide_indices LATEX_HIDE_INDICES
\refitem cfg_latex_output LATEX_OUTPUT
@@ -1280,21 +1282,18 @@ AClass::ANamespace, ANamespace::*Test
<dt>\c HTML_HEADER <dd>
\addindex HTML_HEADER
The \c HTML_HEADER tag can be used to specify a user-defined HTML
- header file for each generated HTML page. To get valid HTML the header file
- should contain at least a \c \<HTML\> and a \c \<BODY\> tag, but it is
- good idea to include the style sheet that is generated by doxygen as well.
- Minimal example:
-\verbatim
- <HTML>
- <HEAD>
- <TITLE>My title</TITLE>
- <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
- </HEAD>
- <BODY BGCOLOR="#FFFFFF">
-\endverbatim
+ header file for each generated HTML page.
If the tag is left blank doxygen will generate a
standard header.
+ To get valid HTML the header file that
+ includes any scripts and style sheets that doxygen
+ needs, it is highly recommended to start with a default header using
+\verbatim
+doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile
+\endverbatim
+ and then modify the file \c new_header.html.
+
The following markers have a special meaning inside the header and footer:
<dl>
<dt><code>\$title</code><dd>will be replaced with the title of the page.
@@ -1303,55 +1302,83 @@ AClass::ANamespace, ANamespace::*Test
<dt><code>\$year</code><dd>will be replaces with the current year.
<dt><code>\$doxygenversion</code><dd>will be replaced with the version of doxygen
<dt><code>\$projectname</code><dd>will be replaced with the name of
- the project (see \c PROJECT_NAME)
+ the project (see \ref cfg_project_name "PROJECT_NAME")
<dt><code>\$projectnumber</code><dd>will be replaced with the project number
- (see \c PROJECT_NUMBER)
+ (see \ref cfg_project_number "PROJECT_NUMBER")
<dt><code>\$projectbrief</code><dd>will be replaced with the project brief
- description (see \c PROJECT_BRIEF)
+ description (see \ref cfg_project_brief "PROJECT_BRIEF")
<dt><code>\$projectlogo</code><dd>will be replaced with the project logo
- (see \c PROJECT_LOGO)
+ (see \ref cfg_project_logo "PROJECT_LOGO")
+ <dt><code>\$treeview</code><dd>will be replaced with links to
+ the javascript and style sheets needed for the navigation tree
+ (or an empty string when \ref cfg_generate_treeview "GENERATE_TREEVIEW"
+ is disabled).
+ <dt><code>\$search</code><dd>will be replaced with a links to
+ the javascript and style sheets needed for the search engine
+ (or an empty string when \ref cfg_searchengine "SEARCHENGINE"
+ is disabled).
+ <dt><code>\$mathjax</code><dd>will be replaced with a links to
+ the javascript and style sheets needed for the MathJax feature
+ (or an empty string when \ref cfg_use_mathjax "USE_MATHJAX" is disabled).
<dt><code>\$relpath\$</code><dd>
If \c CREATE_SUBDIRS is enabled, the command <code>\$relpath\$</code> can be
used to produce a relative path to the root of the HTML output directory,
e.g. use \$relpath\$doxygen.css, to refer to the standard style sheet.
</dl>
-
- See also section \ref doxygen_usage for information on how to generate
- the default header that doxygen normally uses.
- @note When using a custom header you are responsible
- for the proper inclusion of any scripts and style sheets that doxygen
- needs, which is dependent on the configuration options used.
- It is adviced to generate a default header using
+ To cope with differences in the layout of the header and footer that depend on
+ configuration settings, the header can also contain special blocks that
+ will be copied to the output or skipped depending on the configuration.
+ Such blocks have the following form:
\verbatim
-doxygen -w html header.html footer.html stylesheet.css YourConfigFile
+ <!--BEGIN BLOCKNAME-->
+ Some context copied when condition BLOCKNAME holds
+ <!--END BLOCKNAME-->
+ <!--BEGIN !BLOCKNAME-->
+ Some context copied when condition BLOCKNAME does not hold
+ <!--END !BLOCKNAME-->
\endverbatim
- and then modify that header.
+ The following block names are supported:
+ <dl>
+ <dt><code>DISABLE_INDEX</code><dd>Content within this block is copied to the output
+ when the \ref cfg_disable_index "DISABLE_INDEX" option is enabled (so when the index is disabled).
+ <dt><code>GENERATE_TREEVIEW</code><dd>Content within this block is copied to the output
+ when the \ref cfg_generate_treeview "GENERATE_TREEVIEW" option is enabled.
+ <dt><code>SEARCHENGINE</code><dd>Content within this block is copied to the output
+ when the \ref cfg_searchengine "SEARCHENGINE" option is enabled.
+ <dt><code>PROJECT_NAME</code><dd>Content within the block is copied to the output
+ when the \ref cfg_project_name "PROJECT_NAME" option is not empty.
+ <dt><code>PROJECT_NUMBER</code><dd>Content within the block is copied to the output
+ when the \ref cfg_project_number "PROJECT_NUMBER" option is not empty.
+ <dt><code>PROJECT_BRIEF</code><dd>Content within the block is copied to the output
+ when the \ref cfg_project_brief "PROJECT_BRIEF" option is not empty.
+ <dt><code>PROJECT_LOGO</code><dd>Content within the block is copied to the output
+ when the \ref cfg_project_logo "PROJECT_LOGO" option is not empty.
+ <dt><code>TITLEAREA</code><dd>Content within this block is copied to the output
+ when a title is visible at the top of each page. This is the case
+ if either \ref cfg_project_name "PROJECT_NAME",
+ \ref cfg_project_brief "PROJECT_BRIEF", \ref cfg_project_logo "PROJECT_LOGO"
+ is filled in or if both \ref cfg_disable_index "DISABLE_INDEX" and
+ \ref cfg_searchengine "SEARCHENGINE" are enabled.
+ </dl>
+
+ See also section \ref doxygen_usage for information on how to generate
+ the default header that doxygen normally uses.
@note The header is subject to change so you typically
- have to redo this when upgrading to a newer version of doxygen or when
- changing the value of configuration settings such as \c GENERATE_TREEVIEW!
+ have to regenerate the default header when upgrading to a newer version of
+ doxygen.
\anchor cfg_html_footer
<dt>\c HTML_FOOTER <dd>
\addindex HTML_FOOTER
The \c HTML_FOOTER tag can be used to specify a user-defined HTML footer for
- each generated HTML page. To get valid HTML the footer file should contain
- at least a \c \</BODY\> and a \c \</HTML\> tag. A minimal example:
-\verbatim
- </BODY>
- </HTML>
-\endverbatim
+ each generated HTML page.
If the tag is left blank doxygen will generate a standard footer.
- The following commands have a special meaning inside the footer:
- <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>,
- <code>\$doxygenversion</code>, <code>\$projectname</code>,
- <code>\$projectnumber</code>.
- Doxygen will replace them by respectively
- the title of the page, the current date and time, only the current date,
- the version number of doxygen, the project name (see \c PROJECT_NAME), or the
- project number (see \c PROJECT_NUMBER).
+ See \ref cfg_html_header "HTML_HEADER" for more information on
+ how to generate a default footer and what special commands can be
+ used inside the footer.
See also section \ref doxygen_usage for information on how to generate
the default footer that doxygen normally uses.
@@ -1367,6 +1394,16 @@ doxygen -w html header.html footer.html stylesheet.css YourConfigFile
See also section \ref doxygen_usage for information on how to generate
the style sheet that doxygen normally uses.
+\anchor cfg_html_extra_files
+<dt>\c HTML_EXTRA_FILES <dd>
+ \addindex HTML_EXTRA_FILES
+ The \c HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+ other source files which should be copied to the HTML output directory. Note
+ that these files will be copied to the base HTML output directory. Use the
+ $relpath$ marker in the \c HTML_HEADER and/or \c HTML_FOOTER files to load these
+ files. In the \c HTML_STYLESHEET file, use the file name only. Also note that
+ the files will be copied as-is; there are no commands or markers available.
+
\anchor cfg_html_colorstyle_hue
<dt>\c HTML_COLORSTYLE_HUE <dd>
\addindex HTML_COLOR_STYLE_HUE
@@ -1821,6 +1858,14 @@ EXTRA_PACKAGES = times
the title of the page, the current date and time, only the current date,
the version number of doxygen, the project name (see \c PROJECT_NAME), or the
project number (see \c PROJECT_NUMBER).
+
+\anchor cfg_latex_footer
+<dt>\c LATEX_FOOTER <dd>
+ \addindex LATEX_FOOTER
+ The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
+ the generated latex document. The footer should contain everything after
+ the last chapter. If it is left blank doxygen will generate a
+ standard footer. Notice: only use this tag if you know what you are doing!
\anchor cfg_pdf_hyperlinks
<dt>\c PDF_HYPERLINKS <dd>
diff --git a/doc/doxygen.1 b/doc/doxygen.1
index 7006eb4..37e4adb 100644
--- a/doc/doxygen.1
+++ b/doc/doxygen.1
@@ -31,7 +31,7 @@ doxygen \fB\-w\fR rtf styleSheetFile
HTML:
doxygen \fB\-w\fR html headerFile footerFile styleSheetFile [configFile]
.TP
-LaTeX: doxygen \fB\-w\fR latex headerFile styleSheetFile [configFile]
+LaTeX: doxygen \fB\-w\fR latex headerFile footerFile styleSheetFile [configFile]
.TP
5) Use doxygen to generate an rtf extensions file
.TP
diff --git a/doc/language.doc b/doc/language.doc
index f773ab6..9622e87 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -164,7 +164,7 @@ when the translator was updated.
<td>Italian</td>
<td>Alessandro Falappa<br/>Ahmed Aldo Faisal</td>
<td>alessandro at falappa dot net<br/>aaf23 at cam dot ac dot uk</td>
- <td>1.6.0</td>
+ <td>up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Japanese</td>
@@ -351,7 +351,7 @@ when the translator was updated.
\hline
Indonesian & Hendy Irawan & {\tt\tiny ceefour at gauldong dot net} & 1.4.6 \\
\hline
- Italian & Alessandro Falappa & {\tt\tiny alessandro at falappa dot net} & 1.6.0 \\
+ Italian & Alessandro Falappa & {\tt\tiny alessandro at falappa dot net} & up-to-date \\
~ & Ahmed Aldo Faisal & {\tt\tiny aaf23 at cam dot ac dot uk} & ~ \\
\hline
Japanese & Hiroki Iseri & {\tt\tiny goyoki at gmail dot com} & 1.6.0 \\
diff --git a/doc/translator_report.txt b/doc/translator_report.txt
index 0d401aa..91bda18 100644
--- a/doc/translator_report.txt
+++ b/doc/translator_report.txt
@@ -10,7 +10,7 @@ Persian, Polish, Portuguese, Romanian, Russian, Serbian,
SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian,
and Vietnamese.
-Of them, 14 translators are up-to-date, 24 translators are based on
+Of them, 15 translators are up-to-date, 23 translators are based on
some adapter class, and 2 are English based.
----------------------------------------------------------------------
@@ -28,6 +28,7 @@ still may be some details listed even for them:
TranslatorEnglish
TranslatorEsperanto
TranslatorGreek
+ TranslatorItalian
TranslatorKorean -- Change the base class to Translator.
TranslatorPersian -- The MAX_DOT_GRAPH_HEIGHT found in trLegendDocs()
TranslatorSlovak
@@ -64,7 +65,6 @@ must be implemented to become up-to-date:
TranslatorJapanese 1.6.0 9 methods to implement (4 %)
Note: Reimplementation using UTF-8 suggested.
- TranslatorItalian 1.6.0 9 methods to implement (4 %)
TranslatorFinnish 1.6.0 9 methods to implement (4 %)
TranslatorChinesetraditional 1.6.0 9 methods to implement (4 %)
Note: Reimplementation using UTF-8 suggested.
@@ -379,24 +379,6 @@ TranslatorIndonesian (TranslatorAdapter_1_4_6) 32 methods to implement (14 %)
virtual QCString trNoDescriptionAvailable()
-TranslatorItalian (TranslatorAdapter_1_6_0) 9 methods to implement (4 %)
------------------
-
- Implements 216 of the required methods (96 %).
-
- Missing methods (should be implemented):
-
- virtual QCString trSearching()
- virtual QCString trNoMatches()
- virtual QCString trLoading()
- virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime)
- virtual QCString trFileIn(const char * name)
- virtual QCString trGlobalNamespace()
- virtual QCString trDirRelation(const char * name)
- virtual QCString trDirDependency(const char * name)
- virtual QCString trIncludesFileIn(const char * name)
-
-
TranslatorJapanese (TranslatorAdapter_1_6_0) 9 methods to implement (4 %)
------------------