A way to divorce the filename of a companion guide from its name in the text? #84

Open
amyworrall opened this Issue Mar 11, 2011 · 2 comments

Comments

Projects
None yet
2 participants
@amyworrall

I'd like to call a companion guide "Installation Guide". However, I'd rather its filename was something like "install.html" that doesn't contain spaces. But everywhere I crossreference it in the text should refer to the human readable version of the name.

Perhaps in the included file (install.html), a comment like /// @name Installation Guide could get parsed, and then wherever I write <install> in another document, it would become a text link with the text Installation Guide?

@amyworrall

This comment has been minimized.

Show comment Hide comment
@amyworrall

amyworrall Mar 11, 2011

I've filed bug 85 outlining how doxygen handles this.

I've filed bug 85 outlining how doxygen handles this.

@tomaz

This comment has been minimized.

Show comment Hide comment
@tomaz

tomaz Mar 11, 2011

Owner

If you're using template document (i.e. install-template.html), you could do this:

[Installation Guide](install)

If it's not template document, you could do

[Installation Guide](path/to/install.html)

Although this does require repeating the same Markdown link all over. Using @ directive to name a document would be possible, but bare in mind it would only work for template documents (with filenames with suffix -template). I wouldn't use @name though as it's already used for method sections.

Owner

tomaz commented Mar 11, 2011

If you're using template document (i.e. install-template.html), you could do this:

[Installation Guide](install)

If it's not template document, you could do

[Installation Guide](path/to/install.html)

Although this does require repeating the same Markdown link all over. Using @ directive to name a document would be possible, but bare in mind it would only work for template documents (with filenames with suffix -template). I wouldn't use @name though as it's already used for method sections.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment