Skip to content
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.

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

Plantuml ditaa diagram is not visible in refman.pdf #8657

Closed
broucke opened this issue Jul 9, 2021 · 8 comments
Closed

Plantuml ditaa diagram is not visible in refman.pdf #8657

broucke opened this issue Jul 9, 2021 · 8 comments

Comments

@broucke
Copy link

broucke commented Jul 9, 2021

Describe the bug

The plantuml ditaa diagram is not visible in LaTeX ouput, but it is visible in html output.

Expected behavior

I expect the diagram to be visible in ./latex/refman.pdf.

To Reproduce

The example consists out of 2 files:

  • the doxygen configuration file ./doxygen.conf
  • the input file ./mainpage.dox
# Example structure
$ tree
.
├── doxygen.conf
└── mainpage.dox
/** \mainpage ditaa example
\startuml {example.png} "ditaa example"
ditaa
    +--------+   +-------+    +-------+
    |        | --+ ditaa +--> |       |
    |  Text  |   +-------+    |diagram|
    |Document|   |!magic!|    |       |
    |     {d}|   |       |    |       |
    +---+----+   +-------+    +-------+
        :                         ^
        |       Lots of work      |
        +-------------------------+
\enduml
 */
# Config file generated with: doxygen -g doxygen.conf

# Manual changes to doxygen.conf:
INPUT=mainpage.dox
PLANTUML_JAR_PATH=/opt/plantuml/plantuml.1.2021.8.jar

Commands used to generate the html and LaTeX output:

doxygen doxygen.conf && make -C ./latex

Screen shots
Html output
html_output

LaTeX output
latex_output

Version

# Doxygen compiled from source
$ doxygen --version 
1.9.1 (ef9b20ac7f8a8621fcfc299f8bd0b80422390f4b)
$ lsb_release -a
No LSB modules are available.
Distributor ID:	LinuxMint
Description:	Linux Mint 19.3 Tricia
Release:	19.3
Codename:	tricia
$ java -jar /opt/plantuml/plantuml.1.2021.8.jar -version
PlantUML version 1.2021.8 (Sat Jun 26 10:20:59 CEST 2021)
(GPL source distribution)
Java Runtime: OpenJDK Runtime Environment
JVM: OpenJDK 64-Bit Server VM
Default Encoding: UTF-8
Language: en
Country: US
 
PLANTUML_LIMIT_SIZE: 4096

Dot version: dot - graphviz version 2.40.1 (20161225.0304)
Installation seems OK. File generation OK
$ tex --version
TeX 3.14159265 (TeX Live 2017/Debian)
kpathsea version 6.2.3
Copyright 2017 D.E. Knuth.
There is NO warranty.  Redistribution of this software is
covered by the terms of both the TeX copyright and
the Lesser GNU General Public License.
For more information about these matters, see the file
named COPYING and the TeX source.
Primary author of TeX: D.E. Knuth.

Additional context

  • I also tried this with doxygen 1.8.13, on ubuntu 16.04. (doxygen as binary from distribution). The results are the same.
  • It looks like the generated eps file (./latex/example.eps) is corrupted somehow. I tried opening it with inkscape and failed. That is probably why the eps to pdf converter is unable to convert it to pdf. The ./latex/example.pdf file exists, but it is blank. That is why it is probably blank in ./latex/refman.pdf.
  • I could not find any warnings or errors in the ./latex/refman.log file. The only output related to ./latex/example.pdf is:
(./index.tex <./example.pdf>
<example.pdf, id=25, 597.23125pt x 845.1575pt>
File: example.pdf Graphic file (type pdf)
<use example.pdf>
Package pdftex.def Info: example.pdf  used on input line 3.

@albert-github
Copy link
Collaborator

It looks like the generated eps file is not an eps file but a png file.
It looks like a problem with plantuml, though I will have to check a bit deeper (and see if I can find some older plantuml versions).

@albert-github
Copy link
Collaborator

albert-github commented Jul 9, 2021

I did some further investigations and filed a report with plantuml as: https://forum.plantuml.net/14205/eps-output-not-working-for-ditaa
Hopefully they will fix it quickly.

(marking this issue as "invalid", i.e. not a doxygen problem).

The bug report at plantuml (for completeness):

When I have a plantuml file (ba.pu) like:

@startuml
Bob -> Alice : hello
@enduml

and use:

java -Djava.awt.headless=true -jar plantuml.jar -charset UTF-8 -teps ba.pu

the resulting ba.eps is an eps file, though when I have the file ditaa.pu with:

@startditaa
    +--------+   +-------+    +-------+
    |        | --+ ditaa +--> |       |
    |  Text  |   +-------+    |diagram|
    |Document|   |!magic!|    |       |
    |     {d}|   |       |    |       |
    +---+----+   +-------+    +-------+
        :                         ^
        |       Lots of work      |
        +-------------------------+
@endditaa

and use

java -Djava.awt.headless=true -jar plantuml.jar -charset UTF-8 -teps ditaa.pu

the resulting ditaa.eps is not an eps file but a png file.

Used version:

PlantUML Version 1.2021.8beta3

This problem has been reported against doxygen (https://github.com/doxygen/doxygen/issues/8657), but is clearly not a doxygen problem.

@albert-github albert-github added the invalid bug report is not complete, or not reproducible or not a doxygen issue label Jul 9, 2021
@broucke
Copy link
Author

broucke commented Jul 9, 2021

Ok, makes sense. Thanks for the quick follow up! Hopefully it will be fixed quickly.

@broucke broucke closed this as completed Jul 9, 2021
@albert-github albert-github added enhancement a request to enhance doxygen, not a bug and removed bug invalid bug report is not complete, or not reproducible or not a doxygen issue labels Jul 10, 2021
@albert-github
Copy link
Collaborator

I'm not optimistic that it will be fixed soon. On my question on plantuml I got an answer:

image

(see page: https://plantuml.com/ditaa)

Reopening this issue as an enhancement request (maybe we also need a line in the documentation for the time being).

@albert-github albert-github reopened this Jul 10, 2021
albert-github added a commit to albert-github/doxygen that referenced this issue Jul 10, 2021
- small extra notes in usage for engines: ditaa (see issue doxygen#8657) , latex and math
- some textual improvements
albert-github added a commit to albert-github/doxygen that referenced this issue Jul 11, 2021
The current version of plantuml does not support EPS as output format for `ditaa` (Diagram through ascii art), so we have to revert to PNG in this case.
@albert-github albert-github added bug LaTeX and removed enhancement a request to enhance doxygen, not a bug labels Jul 11, 2021
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #8661

@broucke
Copy link
Author

broucke commented Jul 11, 2021

Waw, thanks a lot!

albert-github added a commit to albert-github/doxygen that referenced this issue Jul 15, 2021
- Using `find` instead of explicit loop
- documentation (instead of doxygen#8662)
@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Jul 16, 2021
@albert-github
Copy link
Collaborator

Code has been integrated in master on github (please don't close the issue as this will be done at the moment of an official release).

@doxygen
Copy link
Owner

doxygen commented Aug 18, 2021

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.9.2.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 18, 2021
@doxygen doxygen closed this as completed Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants