There are some parts in my .org file that I don't want to be exported. I am not sure how could I do that. Here is an example file to illustrate what I mean:
* Should be exported
bla bla
** Should be exported
*** Secret part that should not be exported; the same goes for its child sections
The contents should not be exported either.
**** Child section (not exported)
*** Should be exported
** Should be exported
You can use export and noexport tags to accomplish it. In order to enable this feature, you need to add
#+EXPORT_SELECT_TAGS: export
#+EXPORT_EXCLUDE_TAGS: noexport
to you document.
Related
I have a rather complex project and I want to document it using doxygen.
I have no problem documenting the code and I also managed to have a nice front-page using a custom README.md file coupled with "USE_MDFILE_AS_MAINPAGE = README.md" directive in Doxyfile.
I defined several groups (#defgroup) which show up as "Modules" in my documentation.
I would like to add a "main page" to each of the group giving general information, beside the customary function/variable/type documentation.
I tried adding custom MODULENAME.md files coupled with matching #includedoc MODULENAME.md entries in group definition, it seem to work (I see several lines like: "Generating docs for page md_mcu_noitr_coro_README..."), but I cannot find if and where the page is linked (I expected to see it in the "Detailed Description" for the module, as it happens if I put some documentation inline where I put the "#includedoc" directive.
a snippet of one of my modules is:
/**
* #file coro.h
* #brief definition of coroutine implementing functions.
*
* #date: Feb 8, 2018
* #author: myself
*
* #defgroup coro "Coroutine implementation in plain 'C'."
*
* #includedoc mcu_noitr/coro/README.md
* #{
*
*/
What am I doing wrong?
Note: it is also a bit surprising I need to put the whole path from where my Doxyfile is, otherwise doxygen won't find it even if it's right beside the file containing the #includedoc command.
I also came across the problem that included files with Markdown formatted text via \includedoc or \include{doc} does not result in correctly interpreted Markdown. Note that I included Markdown files from other Markdown files. My work-around was to use the C pre-processor (cpp) - which is widely available - on Markdown files and use it's #include directive. You could of course use a true general text processor such as M4 as suggested in the cpp man page. Set FILTER_PATTERNS in Doxyfile as:
FILTER_PATTERNS = *.md="cpp -P -traditional-cpp"
You'll need the -P option to avoid it outputting line markers, which confuses Doxygen. -traditional-cpp was needed to avoid cpp eating white space that is important for the correct interpretation of Markdown. Don't use single quotes as this results in an error when Doxygen calls cpp via sh.
Then in my Markdown main page:
Main Page {#mainpage}
==========
Blah blah blah.
#include "other.md"
Using FILTER_PATTERNS instead of INPUT_FILTER avoids the problem about not being allowed to add or remove lines.
I have my markdown files in the same directory, I would guess that if they are located in different places you could tell cpp about it via -I, which would address your expectations about include paths on the issue you filed.
At the moment doxygen does not consider the fact that commands like \includedoc can contain markdown code. At the moment the only possibility would be to write a filter, see configuration parateter INPUT_FILTER in the doxygen configuration file, (not tested!) to replace the \includedoc` with the code of that file.
I'm new with Doxygen, and i have been commenting my functions with the Qt style approach:
/*! .. */
Doxygen however only picks up my header files and does not generate documentation of any text that is within these comments.
The html file rendered, shows a completely empty main page, "Classes' only list the structs
that are found in the header files and "Files" lists only the same header files in the project.
What may cause this behavior, or is this to be expected?
Am i missing something? The only thing i changed in the configuration file was the INPUT directory to be "src".
No errors during compilation, i see that it is preprocessing and parsing my .c files. And at some point it says this, but only for the header files
Generating code for file src/foo.h...
Generating code for file src/bar.h...
etc.
Finally i get some warnings about structs not being documented, but nothing about the functions I want to have actually documented.
Using org-mode 8.0.3 and TaskJuggler 3. I would like to be able to mix notes with TaskJuggler information in an org-mode file (in true literate programming style). Like this (pseudocode):
* Project :taskjuggler_project:
* Task 1
:PROPERTIES:...
* SubTask
:PROPERTIES:...
* Meeting Notes
* Journal
* Task 2
:PROPERTIES:...
The sections without TaskJuggler-specific properties (Meeting Notes and Journal) still get exported to the tjp file and appear in my reports.
I would like:
Ideally, to exclude the Meeting Notes and Journal from my tjp file
If that's not possible, an easy way to hide them from my reports in the TaskJuggler report definitions. I have the report definitions in a tji file.
Have you tried setting a :noexport: tag on the headlines you don't want exported?
This will prevent them from exporting regardless of the exporter type, although you can remove the tag when exporting to another format that you do want that content included (if you ever do so).
See Export Settings, specifically the section on Exclude Tags for more details.
I want to place some customization codes in a separate file, and include it from other files later. For example, file config.org has a single line #+MATHJAX: align:"left" mathml:t. How do I include it in another .org file abc.org so that the net-effect is exactly same as I write that #+MATHJAX line directly in abc.org?
Use #+setupfile: /path/to/config.org documented here.
The #+INCLUDE directive can include another file with export options (but it cannot affect the configuration of the enclosing file, since it is only for export purposes). Use it like:
#+INCLUDE: "/path/to/config.org"
Is there a simple way to add something like the {Back to Worg's index} to every .org page in a directory which I plan to publish with org-publish-project-alist? Is this accomplished with a #+ tag, or some definition in the .css file?
I looked at how they did it on Worg, and it doesn't look like CSS.
There are a few ways you might be able to do so.
Create a generic file that only includes the details you want in each file. For example:
[[./index.org][Back to index]]
Then use #+include: <filename> at the location in your file where you want the line. (See Include Files)
Alternately you could define a macro in a setupfile (See In-Buffer Settings) that is the definition of the link (or multiple link choices)
#+macro: toIndex [[./index.org][Back to index]]
In both cases it is worth noting that the relative paths are based on the exported file. So a [[../index.org]] will always point to the index.org file in the parent directory, no matter where the setupfile is.