Doxygen - How to link to the Modules page - doxygen

How do i link to the modules page where all groups are listed?
I know i can link to modules.html, but this will not work if i create a format other then html (e.g. PDF).

You could create an alias for something like this:
\htmlonlylink\endhtmlonly \latexonly\hyperlink{...}\endlatexonly
The problem is that the \Chapter{Modules} does not have an attached \label. Maybe you can reference the first module, since the module's individual pages provide labels.
I have not tried it for other output formats.

Related

Is it possible to use nested links in Markdown -> to use in github

I would like to find a way to use nested url links in markdown (or a simple code) to be able to:
have a reference file in GitHub (reference.md) containing all the links that I cite several times in several *.md files in my repository. This to be able to correct broken links in one place without having to crosscheck all my files. Is this possible?
ex:
reference.md file contains: [citat1]:url
files 1.md...2.md..n.md contain code meaning something like: [citat1](lookup and use the url given in reference.md)
so if I click on citat1 on the generated webpage from the different files 1...2 the link would be active and redirect me to the appropriate url.
Anyone can help or point in the right direction? thanks

Using Jekyll for Website without Blog

I'd like to use Jekyll for my website, but I can't figure out how to set it up. All of the documentation I've seen shows how to use Jekyll to set up a blog. I just want to write Markdown and have Jekyll convert it to a website.
I understand that this question is a bit vague and the terminology may not be perfectly accurate. I'm new to creating a website and I don't want to learn HTML.
(Disclosure: My website will be for a project on GitHub.)
There's four types of document that you can find in a Jekyll site :
Static files like js, css or even html page. They don't have a front matter, are simply copied at generation time and can be found in the site.static_files hash,
posts they are located in _posts folder, have a front matter and can be found in the site.posts hash by liquid,
pages they can be anywhere in your folder structure, have a front matter and can be found in the site.pages hash by liquid,
collections that are more elaborated pieces of datas with a front matter and can be found in site.collections hash by liquid.
You can choose to use any of them. If you don't want to use posts, just remove or empty the _posts folder and just use pages.
If all you want to do is write markdown and have that generate a single page for a project, consider using the GH-pages automatic generator.
In step 3 you write the content for your page in Github-flavoured Markdown and then select a layout to publish it in.

Changing the Moodle footer logo

How to change the Moodle logo which will be displayed at the footer page and change to some other logo? As per the given link 1 I have tried but I could not find the footer.html file in my themes folder.
So please help me with some other method (which does not use local machine because I'm working with a remote machine where I could access only the Moodle site, and nothing more than that) to change the logo and link of Moodle.
This depends on your theme - So you're not going to get a precise answer unless you post more details. But here's the gist:
Every theme is made in parts. Normally, you have a header, a content, a sidebar (or two) and a footer.
You want to be editing the footer file.
The footer file is going to be something within the lines of footer.html or footer.php... Something like that. Again, every theme is different so it could be called something completely different. Sometimes, you just need to dig around.
Please also consider that your footer file may also be contained in a sub-directory in your theme folder. So make sure you have a proper look before deciding to "call off the search".
Anyway, once you've found your footer file (Whatever it's called), you'll want to open it and find the image.
If the image is inserted as a HTML reference of location, you can find it by Ctrl+F and typing in the name of the image file. E.g. "footer.jpeg" or whatever.
If the image is inserted as a PHP relative reference, e.g. "$FooterImage" then don't change that, instead, find out where the variable is pointing to in terms of the file-path, and go and edit that image file via FTP instead. You don't have to keep the PHP variable, but I'd keep it in for code-integrity purposes.
Tip for the future: Please include information like name of theme and Moodle version. It enables us to help you better.
Clean Theme:
Things are a bit different with Clean Theme as it doesn't have a single footer file.
You need to go into all layout files one at a time.
Look for this div:
<footer id="page-footer">
...
</footer>
In this footer, you will find a PHP command that says:
echo $OUTPUT->home_link();
To remove the logo, remove this line.
To replace the logo, you can either:
Replace the "home_link" reference in PHP to point to the new image file.
Or
Remove the PHP line and replace it with
?><img src="link_to_your_image" alt="Logo"><?PHP
Remember, you will need to do this for all layout files.
Have a look at Footer replacement at the official Moodle Documentation. Hope that helps.

Remove "generated by doxygen" and timestamp in PDF

As the title. I've just started using doxygen, with the first test run I noticed the PDF created has "created by doxygen 1.8.3.1" followed by the date and time, across the front page.
Is it possible to remove this? or even just move it, say to the end of the document?
I have noted other similar questions but only for the HTML (or RTF which Im not generating) and not PDF
You can do this by using a custom LaTeX header.
First generate a default one using
doxygen -w latex header.tex footer.tex doxygen.sty
now edit the header.tex and look for the "Generated on ..." part and replace that by something of your liking.
Then mention the customized header in doxygen's configuration file
LATEX_HEADER = header.tex
and run doxygen as normal.
Note: When you upgrade to a newer version of doxygen you may need to update your custom header as well.
I believe you should use the HTML_FOOTER configuration tag.
I haven't tested this, but it sounds right:
The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each generated HTML page. If the tag is left blank doxygen will generate a standard footer.

change html output doxygen link

I am working on a project that is heavily documented with doxygen.
In a UI I have a list of all the classes available - I would like to be able to open the right documentation page of the class I select. In order to do that I need an easy to read link, so I can dynamically build it and run it.
Is it there any way I can control the generated link of the html file? Because the ones I have right now are impossible do be built dynamically.
You could use Doxygen's tag file mechanism for that (see GENERATE_TAGFILE in the config file).
A tag file is a reasonably easy to understand and parse XML file that basically lists all symbols in your project, with for each symbol the corresponding (relative) URL to the documentation.
So you could parse the tag file from your UI to resolve the links to the doxygen generated documentation in a robust way.