2012-08-22 4 views
7

Ich benutze Doxygen, um HTML-Ausgabe zu erstellen.Ändern der Position der index.html Datei in Doxygen Ausgabe

Ich möchte die Ausgabe anpassen, so dass die index.html-Datei mehr auffällig sein könnte, da im Moment ist es eine große Liste von Dateien in der HTML-Ausgabe Ordner auf halbem Weg begraben.

Zum Beispiel, wenn es ein Verzeichnis nach oben verschoben wurde, um außerhalb der 'Bits and Pieces' HTML-Dateien zu sein, dann wäre es viel zugänglicher für andere, die danach suchen werden. Ich kann jedoch nicht einfach eine Skriptzeile einfügen, um sie an diesen Speicherort zu kopieren, da alle darin enthaltenen Links unterbrochen werden.

Wenn ich Doxygen so konfigurieren könnte, dass die Indexdatei an einen anderen Speicherort verschoben wird oder wenn Sie eine andere Lösung für mein Problem finden können, wäre ich für Ihre Antwort dankbar.

Dank

+0

Warum erstellen Sie nicht einfach einen Symlink oder eine Verknüpfung zu 'index.html' und platzieren Sie diese wo immer du magst? Wenn Sie sich in einem grafischen Dateimanager befinden, wird ein Buchstabe in der Regel in die erste Datei geschrieben, deren Dateiname mit diesem Buchstaben beginnt. Wenn ich 'i' treffe, geht es direkt zu' index.html'. – Chris

+0

@Chris Danke für den Hinweis. Ich werde es versuchen. Ich weiß, es ist leicht für jemanden zu erreichen, der weiß, wonach er suchen soll, aber die Leute werden das Verzeichnis benutzen, ohne zu wissen, dass man dort hinschauen muss. Ich wollte es nur so einfach und klar wie möglich machen. – user1488804

+0

Sicher, also ist ein Symlink/Shortcut im Wurzelverzeichnis Ihres Projekts, das auf './Html/index/html 'verweist, wahrscheinlich Ihre beste Wette. Sie können diesem Symlink alles benennen, was Sie möchten, damit es für Ihre Benutzer offensichtlich ist, was es ist. – Chris

Antwort

2

Als ich die einfachste Lösung ist wahrscheinlich in den Kommentaren zum OP erwähne einen symbolischen Link oder eine Verknüpfung zu der index.html Datei von doxygen erzeugt zu erstellen, anstatt zu versuchen, doxygen zu bekommen, das Layout zu ändern, davon ausgegeben ist Dateien. Dieser Symlink/Shortcut kann dann im Stammverzeichnis Ihres Projekts (oder anderswo) platziert werden, indem Sie auf ./html/index/html zeigen und alles benennen, was Sie möchten, damit es für Ihre Benutzer offensichtlich ist, was es ist.

+1

Noch eine Sache, mit der Sie mir vielleicht helfen können: Bevor dieser Ordner den Endbenutzer erreicht, wird er gezippt und dann entzippt, wahrscheinlich auf einem Windows-Rechner. Das Problem ist, dass Symlinks unter Windows nicht funktionieren, sondern nur in txt-Dateien umgewandelt werden, die den Link enthalten. Ich kann nicht (auch nicht mit meiner begrenzten Glotzfähigkeit) über einen Weg nachdenken, dieses plattformübergreifende Problem zu lösen. Irgendwelche Gedanken? – user1488804

+0

Dies wird wahrscheinlich am besten als separate Frage gestellt. Ich weiß nicht, wie man symbolische Links auf tragbare Weise erstellt, ich wäre überrascht, wenn es einen einfachen Weg dazu gäbe. Sie könnten separate Symlinks für Linux und Windows haben (die spätere Verwendung von 'mklink'). Ich bin mir nicht sicher, ob die Links funktionieren werden, da Sie auf einen relativen Pfad verweisen müssen. – Chris

+0

Das einzige, was ich mir vorstellen kann, was ich jetzt versuchen werde, ist eine HTML-Datei (Index genannt oder was auch immer) zu machen, die ein kleines bisschen Javascript enthält, das auf die Datei im Unterverzeichnis zeigt. Aber ja, ich werde es als eine separate Frage stellen, da ich jemanden brauchen könnte, der etwas über Javascript weiß (nicht ich), um mir dort zu helfen. – user1488804

2

Ich würde die Dokumentation an ihrer Stelle verlassen und stattdessen die Meta-Refresh-Option der HTML-Sprache verwenden. Legen Sie eine Datei mit dem Namen "Documentation.html" in einem beliebigen Ordner mit folgendem Inhalt ab:

<meta http-equiv="REFRESH" content="0;URL=RELATIVE/PATH/TO/index.html">