Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
D
doxverilog
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
Elphel
doxverilog
Commits
b935f319
Commit
b935f319
authored
Sep 04, 2013
by
Petr Prikryl
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc/language.tpl -- UTF-8 reflected in the langhowto template
parent
cfaeb9f4
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
12 deletions
+15
-12
language.tpl
doc/language.tpl
+15
-12
No files found.
doc/language.tpl
View file @
b935f319
...
@@ -93,6 +93,7 @@ This file should now contain a \#define for your language code.
...
@@ -93,6 +93,7 @@ This file should now contain a \#define for your language code.
the \c HEADERS line.
the \c HEADERS line.
<li>
Edit
<code>
translator_xx.h
</code>
:
<li>
Edit
<code>
translator_xx.h
</code>
:
<ul>
<ul>
<li>
Use the UTF-8 capable editor and open the file using the UTF-8 mode.
<li>
Rename
<code>
TRANSLATOR_EN_H
</code>
to
<code>
TRANSLATOR_XX_H
</code>
<li>
Rename
<code>
TRANSLATOR_EN_H
</code>
to
<code>
TRANSLATOR_XX_H
</code>
twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at
twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at
the beginning of the file).
the beginning of the file).
...
@@ -100,18 +101,17 @@ This file should now contain a \#define for your language code.
...
@@ -100,18 +101,17 @@ This file should now contain a \#define for your language code.
<li>
In the member
<code>
idLanguage()
</code>
change "english" into the
<li>
In the member
<code>
idLanguage()
</code>
change "english" into the
name of your language (use lower case characters only). Depending
name of your language (use lower case characters only). Depending
on the language you may also wish to change the member functions
on the language you may also wish to change the member functions
latexLanguageSupportCommand()
, idLanguageCharset() and others
latexLanguageSupportCommand()
and other (you will recognize them when
(you will recognize them when
you start the work).
you start the work).
<li>
Edit all the strings that are returned by the member functions that
<li>
Edit all the strings that are returned by the member functions that
start with tr.
start with
\c
tr.
Try to match punctuation and capitals!
Try to match punctuation and capitals!
To enter special characters (with accents) you can:
To enter special characters (with accents) you can:
<ul>
<ul>
<li>
Enter them directly if your keyboard supports that and you are
<li>
Enter them directly if your keyboard supports that. Recall that
using a Latin-1 font. Doxygen will translate the
the text is expected to be saved using the UTF-8 encoding. Doxygen
characters to proper \f$\mbox{\LaTeX}\f$ and leave the
will translate the characters to proper \f$\mbox{\LaTeX}\f$ and
HTML and man output for what it is (which is fine, if
leaves the HTML and man output in UTF-8.
idLanguageCharset() is set correctly).
<li>
Use html codes like \
ä
for an a with an umlaut (i.e.
ä
).
<li>
Use html codes like \
ä
for an a with an umlaut (i.e.
ä
).
See the HTML specification for the codes.
See the HTML specification for the codes.
</ul>
</ul>
...
@@ -122,7 +122,8 @@ This file should now contain a \#define for your language code.
...
@@ -122,7 +122,8 @@ This file should now contain a \#define for your language code.
in the config file to generate output in your language.
in the config file to generate output in your language.
<li>
Send
<code>
translator_xx.h
</code>
to me so I can add it to doxygen.
<li>
Send
<code>
translator_xx.h
</code>
to me so I can add it to doxygen.
Send also your name and e-mail address to be included in the
Send also your name and e-mail address to be included in the
\c maintainers.txt list.
\c maintainers.txt list. You can also clone the Doxygen repository
at GitHub and make a PullRequest later.
</ol>
</ol>
...
@@ -299,9 +300,11 @@ end with <code>=0;</code>).
...
@@ -299,9 +300,11 @@ end with <code>=0;</code>).
If everything compiles fine, try to run \c translator.py, and have a
If everything compiles fine, try to run \c translator.py, and have a
look at the translator report (ASCII file) at the \c doxygen/doc
look at the translator report (ASCII file) at the \c doxygen/doc
directory. Even if your translator is marked as up-to-date, there
directory. Your translator is marked as up-to-date only if the script
still may be some remarks related to your source code. Namely, the
does not detect anything special. If the translator uses the \c Translator
obsolete methods--that are not used at all--may be listed in the
base class, there still may be some remarks related to your source code.
In the case, the translator is marked as
<em>
almost up-to-date
</em>
.
Namely, the obsolete methods--that are not used at all--may be listed in the
section for your language. Simply, remove their code (and run the \c
section for your language. Simply, remove their code (and run the \c
translator.py again). Also, you will be informed when you forgot to
translator.py again). Also, you will be informed when you forgot to
change the base class of your translator class to some newer adapter
change the base class of your translator class to some newer adapter
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment