Skip to content

Consistency language version table between HTML and LaTeX #11692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 5, 2025
Merged

Consistency language version table between HTML and LaTeX #11692

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Consistency language version table between HTML and LaTeX 
Made generation language version table consistent between HTML and LaTeX, all based on a normal doxygen (HTML) table.
- better heading when table is split over pages
- version needed `\.` instead of `.` otherwise it an artificial linebreak would occur.
  • Loading branch information
@albert-github
albert-github committed Aug 4, 2025
commit 4863daaf9c69f7e6612752ca09db754e8edd93a5
102 changes: 14 additions & 88 deletions doc/translator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1870,28 +1870,23 @@ def generateLanguageDoc(self):

# Define templates for HTML table parts of the documentation.
htmlTableTpl = '''
\\htmlonly
</p>
<table align="center" cellspacing="0" cellpadding="0" border="0">
<tr bgcolor="#000000">
<td>
<table cellspacing="1" cellpadding="2" border="0">
<tr bgcolor="#4040c0">
<td ><b><font size="+1" color="#ffffff"> Language </font></b></td>
<td ><b><font size="+1" color="#ffffff"> Maintainer </font></b></td>
<td ><b><font size="+1" color="#ffffff"> Contact address </font>
<font size="-2" color="#ffffff">(replace the at and dot)</font></b></td>
<td ><b><font size="+1" color="#ffffff"> Status </font></b></td>
\\latexonly
\\footnotesize
\\endlatexonly
<table align="center" class=doxtable cellspacing="1" cellpadding="2">
<tr>
<th >Language</th>
<th >Maintainer</th>
<th >Contact address (replace the at and dot)</th>
<th >Status</td>
</tr>
<!-- table content begin -->
%s
<!-- table content end -->
</table>
</td>
</tr>
</table>
<p>
\\endhtmlonly
\\latexonly
\\normalsize
\\endlatexonly
'''
htmlTableTpl = textwrap.dedent(htmlTableTpl)
htmlTrTpl = '\n <tr bgcolor="#ffffff">%s\n </tr>'
Expand Down Expand Up @@ -1963,85 +1958,16 @@ def generateLanguageDoc(self):

# The last element contains the readable form of the status.
bgcolor = self.getBgcolorByReadableStatus(obj.readableStatus)
lst.append(htmlTdStatusColorTpl % (bgcolor, obj.readableStatus))
lst.append(htmlTdStatusColorTpl % (bgcolor, obj.readableStatus.replace(".","\\.")))

# Join the table data to one table row.
trlst.append(htmlTrTpl % (''.join(lst)))

# Join the table rows and insert into the template.
htmlTable = htmlTableTpl % (''.join(trlst))

# Define templates for LaTeX table parts of the documentation.
latexTableTpl = r'''
\latexonly
\footnotesize
\begin{longtable}{|l|l|l|l|}
\hline
{\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\
\hline
%s
\hline
\end{longtable}
\normalsize
\endlatexonly
'''
latexTableTpl = textwrap.dedent(latexTableTpl)
latexLineTpl = '\n' + r' %s & %s & {\tt\tiny %s} & %s \\'

# Loop through transl objects in the order of sorted readable names
# and add generate the content of the LaTeX table.
trlst = []
for name, obj in self.langLst:
# For LaTeX, more maintainers for the same language are
# placed on separate rows in the table. The line separator
# in the table is placed explicitly above the first
# maintainer. Prepare the arguments for the LaTeX row template.
maintainers = []
if obj.classId in self.__maintainersDic:
maintainers = self.__maintainersDic[obj.classId]

lang = obj.langReadable
maintainer = None # init
email = None # init
if obj.status == 'En':
# Check whether there is the coupled non-English.
classId = obj.classId[:-2]
if classId in self.__translDic:
langNE = self.__translDic[classId].langReadable
maintainer = 'see the %s language' % langNE
email = '~'

if not maintainer and (obj.classId in self.__maintainersDic):
lm = [ m[0] for m in self.__maintainersDic[obj.classId] ]
maintainer = maintainers[0][0]
email = maintainers[0][1]

status = obj.readableStatus

# Use the template to produce the line of the table and insert
# the hline plus the constructed line into the table content.
# The underscore character must be escaped.
trlst.append('\n \\hline')
s = latexLineTpl % (lang, maintainer, email, status)
s = s.replace('_', '\\_')
trlst.append(s)

# List the other maintainers for the language. Do not set
# lang and status for them.
lang = '~'
status = '~'
for m in maintainers[1:]:
maintainer = m[0]
email = m[1]
s = latexLineTpl % (lang, maintainer, email, status)
s = s.replace('_', '\\_')
trlst.append(s)

# Join the table lines and insert into the template.
latexTable = latexTableTpl % (''.join(trlst))

# Put the HTML and LaTeX parts together and define the dic item.
tplDic['informationTable'] = htmlTable + '\n' + latexTable
tplDic['informationTable'] = htmlTable

# Insert the symbols into the document template and write it down.
f = xopen(fDocName, 'w')
Expand Down
Loading