Say I have a page, in the Related Pages section, named states.md.
Now, in the doc of a specific method, I want to tell users to go see that file for more details, like "See states.md", with an hyperlink to the page.
The problem is, I have no problem generating the link (I can use the \ref command like See the \ref states.md "states.md", but it seems to work the same if I just write the name of the file), however the link goes to a empty and useless page rather than the actual page :
If I "manually" go to the Related Pages tab, states.md appears in the list, if I click on it from here I can see the content of the file.
How can I make Doxygen generate a link to the actual content of my file, like it appears in the Related Pages tab ?
You can add an anchor in the headline of markdown and link it directly. This is more clean then linking to the created html file. See official doc.
Here is an examlple:
doit.md:
# Specific Information on doIt() {#doit_specific}
- First do this
- Then that
- And finish up
Then you can link it in your doxygen. e.g. doIt.h:
//! Does it
//!
//! See \ref doit_specific "specific information".
//!
void doIt();
Note: You can also just \ref doit_specific and it will use the headline as the text.
Additional info: Make sure, the markdown page appears in the related page sections. If it does not, you need to edit the doxygen settings. See https://stackoverflow.com/a/9522667/4675668
Related
I have two projects in Redmine and both have their wikis.
Is it possible to link the wiki page of one project to the wiki page of another project?
I ended so far with using of http links:
"Redmine web site":http://www.redmine.org
But I want to use relative paths like this:
[[sandbox:some page]] displays a link to the page named 'Some page' of the Sandbox wiki
The Examples are taken form Redmines official wiki page:
http://www.redmine.org/projects/redmine/wiki/RedmineTextFormattingTextile
You can also define a custom link text for wiki links without having to resort to plain textile links:
[[your-project:your-wiki-page|Relative Path in Redmine]]
Using this syntax, you get the advantage of colored links depending on whether the target page exists or not and correct links on case you ever decide to move your Redmine server.
This and other syntax details are described on the help page you can access by clicking on the small question mark button above most text fields or on https://www.redmine.org/help/en/wiki_syntax_detailed.html.
I found the solution:
You can just direct from Redmines projects folder:
"Relative Path in Redmine":/projects/your-project/wiki/your-wiki-page
Is there a way for a bunch of named anchors in a large html to be clickable within a PhantomJs generated PDF file?
I.e. say I have a table of contents or a list of FAQ questions. When clicking on the question/title - I'm taken to its answer/content within the same HTML file which is great but when the same HTML is rendered into a PDF each named anchor becomes an absolute URL (i.e. http://example.com/render.html#anchor_1) so clicking on it opens a browser with that URL instead of jumping to its content within the PDF file.
So, basically, is it possible (and how?) for a markup like this - https://fiddle.jshell.net/jyjuaaog/ to work within the generated PDF?
BTW, this works great when "printing as a PDF file" in Google Chrome but links end up broken when rendered in PhantomJs so there must be something I'm missing that I can't seem to find in the docs.
Any ideas?
Thanks!
Apparently there's a bug in PhantomJs preventing this. As suggested by PhantomJsCloud a quick-and-dirty workaround would be to replace the links with page links.
I want to manage internal contextual link building in my articles, but somewhat in a well-managed and easier way. It is a pain to change all the link URLs in a text if we change a URL of a page which is linked to many pages in their content.
You shouldn't need to change them if you used the content picker to select the page you are linking to because it inserts a URL in the format {localLink:####} where ### is the id of the document the link is pointing to.
This is then parsed and replaced with the correct and current URL when the document is rendered, so it is always current and correct.
I'd like to include a picture in a page element in an Inquest script: is this possible?
If so, how would you do it?
I know this question was asked 8 years ago...but I recently had the same question. So I thought maybe I could put something here in case someone in the future would have a similar question.
You cannot add a picture to the page element in Inquisit 5, but it would be possible in Inquisit 6. For Inquisit 5, you'll have to use or .
Here's some discussion on this: https://forums.millisecond.com/Topic34836.aspx
There is some discussion here.
In general, it seems that the page element only allows for simple text based instructions.
If you want to present images in instructions, there are a few options.
htmlpage element
You can use the htmlpage element, which allows for instructions to be a complete formatted HTML file that can include images.
The htmlpage element is used to define pages of text to be displayed
as instructions using the preinstructions or postinstructions
attribute. The htmlpage element is useful when complete control over
formatting and content of instruction pages is required, otherwise the
page element provides an easier way to display text with basic
formatting. The actual content of the page is contained in a separate
HTML file located on the local machine or the web. source
Picture or picture and text in a normal trial
The other option is to present instructions as normal stimuli in the main trials of a block.
See for example, the instructions in the sample script for the Iowa Gambling Task.
This can be either done as one integrated picture that includes text, or each image can be positioned as it's own stimuli.
I've generated a website documentation of my project with Sandcastle. This website uses frames so when I click though sites my URL in browser does not change.
I would like to have URL changed in browser when I browse through website documentation generated with Sandcastle. Why? Because I would like to link to concrete subpages of documentation from other parts of my developer environment.
And further more I would like to have this links permanent. So when I generate once again documentation from new version of my project, links will not change so that I will not need to change all links to new.
Is this possible and how to acomplish this?
If you add the code below to the top of SplitScreen.js the browser will "inject" the TOC frame and focus on the content you linked directly to (using the trick Vitaly Shibaev showed).
if (window==top) {
window.location = "/?topic=" + (window.location.pathname.substring(1));
}
This code works it the documentation is placed at the root of your website - if you have it in a sub-folder you need to expand on "/?topic" and remove the sub-folder part from the pathname part.
With this change you can use the "direct links". I also expect people who find you via Google get a better experience (getting the content they searched for AND the TOC bar).
In order to create correct links to specific subpages of documentation you may use similar request: $DOCUMENTATION_ROOT$/Index.aspx?topic=html/$TOPIC_ID$.htm
E.g. http://www.ewoodruff.us/shfbdocs/Index.aspx?topic=html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm
instead of http://www.ewoodruff.us/shfbdocs/html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm
Vitaliy and mawtex have solved the 'how to link to documentation subpages' part of your question.
The "making links permanent so they do not change when regenerating documentation" part of your questions is solved automatically, since the html file names created are based on a hash of the topic name by default. I.e. If you do not change the part of your code that you are documenting, then it will use the same file name.
You can change the way that html file names are generated, but all given methods are based on the member name or a hash of the topic ID, so links shouldn't break if the code hasn't changed.
See Sandcastle Help File Builder's NamingMethod documentation for more info.