Problem:
Cannot customize the Doxygen output for LATEX to hide the page content. DoxgentLayout.xml gives you the ability to show or hide pages for HTML. looking for something equivalent
Why:
I need to remove/hide the pages type. The reason is because I use the modules type to create a tree hierarchy of the detailed design document which is a md file with the classes associated with the design. I use grouping to group the md file and classes together. The reason I have to hide the pages type in doxygen is because as soon as you put \ingroup at the top the .md file the content after that line will not show up this results in a series of blank pages so I just hide them because the content is within the module. So DoxgenLayout.xml will allow me to hide the pages for HTML but I don't have an equivalent for LATEX.
What I have tried:
I tried modifying the refman.tex file after it was generated. When I run make for the LATEX output it always fails. So I don't know if LATEX realizes that the file changed and fails its build or I am doing something wrong.
I tried using the LATEX_HEADER file but same result. I think this was intended to change the style of your PDF more so then what content is shown
at the top of my md files I do this:
\defgroup g_SystemService SystemService Library
\defgroup g_ICP-SCP ICP-SCP
\ingroup g_SystemService g_ICP-SCP
# ICP-SCP System
This system provides...
The PDF output results in this:
HTML output I can hide this by just modifying the DoxygenLayout.xml file to say:
<navindex>
<tab type="pages" visible="no" title="" intro=""/>
refman.tex generation (what I want to is remove these chapters from generation):
...
%--- Begin generated contents ---
% want to remove these pages
\chapter{Base\+Data\+Model}
\label{md_architecture_Common_datamodels_BaseDataModel}
\Hypertarget{md_architecture_Common_datamodels_BaseDataModel}
\input{md_architecture_Common_datamodels_BaseDataModel}
\chapter{Commands}
\label{md_architecture_SystemService_ICP_Commands}
\Hypertarget{md_architecture_SystemService_ICP_Commands}
\input{md_architecture_SystemService_ICP_Commands}
\chapter{I\+C\+P-\/\+S\+CP}
\label{md_architecture_SystemService_ICP_ICP-SCP}
\Hypertarget{md_architecture_SystemService_ICP_ICP-SCP}
\input{md_architecture_SystemService_ICP_ICP-SCP}
\chapter{I\+C\+P-\/\+S\+C\+P\+Manager}
\label{md_architecture_SystemService_ICP_ICP-SCPManager}
\Hypertarget{md_architecture_SystemService_ICP_ICP-SCPManager}
\input{md_architecture_SystemService_ICP_ICP-SCPManager}
\chapter{I\+C\+P\+Comm}
\label{md_architecture_SystemService_ICP_ICPComm}
\Hypertarget{md_architecture_SystemService_ICP_ICPComm}
\input{md_architecture_SystemService_ICP_ICPComm}
\chapter{Unit\+Tests}
\label{md_architecture_SystemService_ICP_UnitTests}
\Hypertarget{md_architecture_SystemService_ICP_UnitTests}
\input{md_architecture_SystemService_ICP_UnitTests}
% end of removing pages
\chapter{Todo List}
\label{todo}
...
Doxygen Version: 1.8.17
Related
I am new to Confluence, and I am playing with it (version 5.10.7).
I am reading the system's code, and I am unable to find out where footer.vm is used. Here is where common-header.vm (another file in Confluence) is used: Inside main.vmd, there is the following line:
#parse("/decorators/includes/common-header.vm")
I am not able to find similar code to use footer.vm.
footer.vm contains following code:
## Page footer for main and admin decorators.
#parse("/decorators/includes/footer-content.vm")
Above code contains the content of the footer.
For example in printable.vmd you can find following which parse the footer file:
#parse ("/decorators/includes/footer.vm")
However, if you want to change the content of the footer you need to change /confluence/decorators/includes/footer-content.vm file.
Also I would recommend you to take a look at this document and ensure that you don't break the EULA.
Org-mode is a power editor. I use it to write scientific notes and produce them into tex/PDF files.
When I produce .org file into .tex or .pdf file, some codes are generated automatically by org-mode, such as:
\hypersetup{
pdfkeywords={},
pdfsubject={},
pdfcreator={Emacs Org-mode version 7.8.11}}
Those codes make some information occupied the first page of PDF file, that is useless for me.
How to prevent those codes from appearing on the tex-file produced and its PDF?
I use this in my init file:
(setq org-latex-with-hyperref nil)
Then you have to put your own hyper setup in where you want it.
I'd like to add a code appendix to my LyX document. There are a few options I already considered, but they all have their problems.
I know a bit about listings, but one problem with those is that, if I copy & paste my code into them, I lose all enters/newlines. Since the code is too large to correct by hand, I was wondering if there is an alternative.
In LyX there is the possibility of inserting child documents, but that seems to be only for .tex files. Would have been ideal if I could just insert my .java file as a child document.
I could print the code to PDF, but it will include margins that mess up the final document, since the PDF is placed on the left margin of the final document and then there is the margin of the PDF. Also, this PDF always contains the entire code and white areas where not the entire page has been filled.
Does anyone have good alternative?
The listings package found here
http://www.ctan.org/tex-archive/macros/latex/contrib/listings/
allows the include of external source code files (look into the reference for \lstinputlisting).
EDIT: here you find some samples how to use it:
http://en.wikibooks.org/wiki/LaTeX/Packages/Listings
If you need to copy-paste code to LyX listing box then use Edit -> Paste Special -> Seletion or Ctrl+Alt+V.
For what it's worth, at least the 2.0 versions of LyX have the ability to include listings as child documents. Insert, File, Child Document, and choose from the dropdown box "Program Listing". This uses the listings package and lets you keep your source in its own file.
If listings doesn't support your language, you can always use something like highlight or source-highlight to generate a latex snippet of syntax-highlighted code that you can add as a child document of type "Input"
Yes, if you copy&paste code into the LyX listings box, you lose all newlines, but you can preprocess your code (insert an extra newline below each line):
$ cat foo.java | sed -e 's/$/\n/' > bar.java
Then you can copy&paste the new file bar.java and everything will be ok.
I'd like to read the Rails 3 source code on printed paper (and preferably in color).
For example, xv6 did a nice job printing their code. It even has line numbers and an index. The only thing I would like to add is syntax highlighting.
Anyone know how any of this is possible?
Here are two possibilities I found:
1. The Listings Package (could this also generate other formats besides PDF, like HTML?)
ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/listings/listings.pdf o
2. Highlight (does it do indexing?)
http://www.andre-simon.de/
We could even add a rake task, print, that generates an up-to-date PDF.
I recomend you use highlight to turn the code into LaTeX and then use Listings to make it into a PDF, then print!
I have a project created with python-sphinx and I use latexpdf to compile the final pdf.
In the final pdf created, in the index it is visible a Contents: string that I would like to delete.
The only way I found by now is to compile only the latex, open the .tex file, look for the string and delete that from there.
Then compile the pdf via latex make all-pdf.
Is there a way to specify that?
My assumption is that you have **Contents** as part of the normal .rst markup and use it as a header before the table of contents (ToC), which is fine in your html.
For LaTeX, however, one ToC is assembled (if there are multiple) and used as the one and only ToC at the beginning of the document. ToCs are not displayed inline. That's why your ToC is displayed before your **Contents** markup.
To just fix this issue you can use Spinx's .. only:: directive:
.. only:: html
**Contents**
Alternatively and to do things the proper way, you can use the :caption: option of the toctree directive:
.. toctree::
:caption: Contents
your-content
here