2015-06-16 9 views
5

Sto usando Doxygen 1.8.6 su Ubuntu 14.04 per generare documentazione API dai file di intestazione C/C++.Doxygen: come incorporare le immagini nella pagina principale per tutti i formati di output?

Ho una pagina principale in formato markdown (file mainpage.md) e voglio incorporare un'immagine (file logo.png) in quella pagina.

Attualmente, ho che lavorare per l'output HTML, con la seguente struttura di directory:

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

Il modo in cui il mark-down in mainpage.md incorpora l'immagine, è:

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

Questo funziona, ma dipende dal fatto che la directory di output HTML è a un livello inferiore rispetto alla directory di lavoro e (fwiw) che non è sincronizzata con la posizione del file mainpage.md che contiene tale riferimento.

devo ammettere che non ho provato che cosa accade con altri formati di output (formati destinati sono: HTML, PDF via LaTex, pagine man, Eclipse aiuto), ma possono funzionare in modo diverso w.r.t. la loro directory di output e il riferimento al file immagine.

Le mie domande sono:

  1. fare i suddetti altri formati di output lavorano con questo riferimento Markdown?

  2. Esiste un modo più agnostico per il formato di output per referenziare il file immagine dal markdown della pagina principale?

Andy

+1

Hai avuto uno sguardo al percorso_immagine = risorse e [Il logo] (logo!. png) per la versione HTML? e al comando @image? – albert

+0

Si prega inoltre di dare un'occhiata alla documentazione del capitolo su Markdown e alla sua implementazione in doxygen: http://www.stack.nl/~dimitri/doxygen/manual/markdown.html – albert

risposta

0

Purtroppo è necessario comandi di immagini multiple per fare questo lavoro. Latex richiederà un tipo di immagine compatibili pdf, browser web di solito richiedono un diverso tipo di immagine, ecc, in modo che il image command deve essere rilasciato più volte per specificare il file immagine per ogni formato

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

Sono supportati i seguenti formati: html, latex, docbook e rtf.

È possibile utilizzare i percorsi più brevi se si mettono le immagini in una cartella di immagini e specificare la sua posizione nel configuration:

IMAGE_PATH  = my_image_dir 
+0

E 'possibile ridimensionare un'immagine quando collegata attraverso Markdown? – phoenix

+0

per latex o html? Per html: https://stackoverflow.com/questions/15975262/how-to-specify-image-size-in-html-doxygen –

+0

per il dimensionamento del lattice, consultare la documentazione di Doxygen per '\ image' https: //www.stack .nl/~ dimitri/doxygen/manual/commands.html # cmdimage –

Problemi correlati