2015-06-16 11 views
5

Ich benutze Doxygen 1.8.6 auf Ubuntu 14.04, um API-Dokumentation aus C/C++ - Header-Dateien zu generieren.Doxygen: Wie Bilder auf der Hauptseite für alle Ausgabeformate einbetten?

Ich habe eine Hauptseite im Markdown-Format (Datei mainpage.md) und möchte ein Bild (Datei logo.png) in diese Seite einbetten.

Derzeit hat ich, dass für die HTML-Ausgabe arbeitet mit folgenden Verzeichnisstruktur:

 
    work 
    ├── mainpage.md 
    ├── resources 
    │   └── logo.png 
    └── html 
     └── index.html 

Die Art und Weise des Abschlag in mainpage.md das Bild einbettet, ist:

![The Logo](../resources/logo.png) 

Dies funktioniert, aber Es hängt davon ab, dass das HTML-Ausgabeverzeichnis eine Ebene unterhalb des Arbeitsverzeichnisses liegt und (fwiw) nicht mit dem Speicherort der mainpage.md-Datei übereinstimmt, die diese Referenz enthält.

Ich muss zugeben, dass ich nicht aus habe versucht, was mit anderen Ausgabeformaten geschieht (intended Formate sind: HTML, PDF über LaTeX, Manpages Eclipse-Hilfe), aber können sie funktionieren anders w.r.t. ihr Ausgabeverzeichnis und der Verweis auf die Bilddatei.

Meine Fragen sind:

  1. Sie die obige andere Ausgabeformate erwähnt mit diesem Abschlags Referenz arbeiten?

  2. Gibt es ein mehr Ausgabeformat agnostische Möglichkeit für die Referenzierung der Bilddatei von der Hauptseite Abschrift?

Andy

+1

Haben Sie einen Blick auf IMAGE_PATH = Ressourcen und [Das Logo] (Logo!. png) für die HTML-Version? und am @image Befehl? – albert

+0

Bitte beachten Sie auch die Dokumentation im Kapitel über Markdown und dessen Implementierung in doxygen: http://www.stack.nl/~dimitri/doxygen/manual/markdown.html – albert

Antwort

0

Leider müssen Sie mehrere Bildbefehle Um diese Arbeit zu machen. Latex wird eine PDF-kompatible Bildtyp benötigen, Web-Browser in der Regel einen anderen Bildtyp erfordern, etc., so dass die image command muss mehrmals ausgegeben werden, um die Bilddatei für jedes Format zu spezifizieren

\image html logo.png 
\image latex logo.eps 

Folgende Formate werden unterstützt: HTML, Latex, Docbook und RTF.

können Sie kürzeren Wege verwenden, wenn Sie Ihre Bilder in einem Bildordner setzen und die Lage in Ihrem configuration angeben:

IMAGE_PATH  = my_image_dir 
+0

Ist es möglich, ein Bild bei der Verknüpfung zu skalieren? durch Markdown? – phoenix

+0

für Latex oder HTML? Für html: https://stackoverflow.com/questions/15975262/how-to-specify-image-size-in-html-doxygen –

+0

für Latex Sizing siehe Doxygen Dokumentation für '\ Image' https: //www.stack .nl/~ dimitri/doxygen/manual/commands.html # cmdimage –

Verwandte Themen