Hi all,
I'm a new user to Doxygen and this list and just updated to Doxygen 1.88 on
Mac OSX 10.9 (Mavericks). I hope you'll forgive me if these questions are
basic. I've spent some time combing through the manual and user group
archives, but haven't found recent answers (2012-2014) that allow me to be
able to configure correctly to Doxygen best practices.
I have a project with the following Directory Layout:
myproject
*--docs*
*html*
*latex*
--src
--doxygen.config
--mainpage.md
--CMakeLists.txt
--README
I'm trying to customize:
A) Font family for both html and latex outputs (and mainpage.md, a markdown
file)
B) Stylesheets for both html and latex outputs (and mainpage.md)
Caveats:
-- At the moment I'm focusing on the HTML output (and .md file) as a
priority.
-- I don't want to overwrite the doxygen.css and tabs.css, as my
understanding is that it is not a "Best Practice." True or False?
-- I also believe that multiple stylesheets and .html files are supported,
but there is an order?
-- Lastly I know I can EXCLUDE the Fonts and Stylesheets (where ever they
live) in the doxygen.config, but want our client to be able to replicate
the Customized results when they re-run the doxygen command.
-- Our engineers don't want these items (Fonts and Stylesheets) in the
src directory. (where they are currently as I test results)
So the questions are:
1) Is there a standard place to put the Font Family folder (Directory
containing 8 weights, bold, italic, bold italic, etc), where it won't get
"blown away" upon a command line rerun of: 'doxygen doxygen.config'?
2) Is there a standard Naming Convention and place to put the:
customstylesheets.css customtabs.css new_header.html new_footer.html
where it won't get "blown away"?
4) Should I have also added HTML_HEADER and HTML_FOOTER in addition to the
above?
I read this:
http://www.stack.nl/~dimitri/doxygen/manual/config.html#config_html
But am not understanding the entirety of the solution.
doxygen -w html new_header.html new_footer.html new_stylesheet.css
YourConfigFile
Should I have all of the following?:
1. new_header.html Styles the HTML Header
2. new_footer.html Styles the HTML Footer
3. customstylesheet.css or/aka new_stylesheet.css Styles everything
else html and latex?
4. customtabs.css Styles the Tabs
5) Is my Config file setup correctly?
doxygen.config:
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = customstylesheet.css customtabs.css
HTML_EXTRA_FILES = Gotham Rounded
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_GAMMA = 80
HTML_TIMESTAMP = YES
HTML_DYNAMIC_SECTIONS = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME = Publisher
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
TOC_EXPAND = NO
GENERATE_QHP = NO
QCH_FILE =
QHP_NAMESPACE = org.doxygen.Project
QHP_VIRTUAL_FOLDER = doc
QHP_CUST_FILTER_NAME =
QHP_CUST_FILTER_ATTRS =
QHP_SECT_FILTER_ATTRS =
QHG_LOCATION =
GENERATE_ECLIPSEHELP = NO
ECLIPSE_DOC_ID = org.doxygen.Project
DISABLE_INDEX = NO
GENERATE_TREEVIEW = NO
ENUM_VALUES_PER_LINE = 4
TREEVIEW_WIDTH = 250
EXT_LINKS_IN_WINDOW = NO
FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES
USE_MATHJAX = NO
MATHJAX_FORMAT = HTML-CSS
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS =
MATHJAX_CODEFILE =
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
EXTERNAL_SEARCH = NO
SEARCHENGINE_URL =
SEARCHDATA_FILE = searchdata.xml
EXTERNAL_SEARCH_ID =
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = YES
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = letter
EXTRA_PACKAGES = /Users/ok/myproject/src/Gotham Rounded
LATEX_HEADER =
LATEX_FOOTER = docs/latex/MyPreamble.tex
LATEX_EXTRA_FILES =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
LATEX_SOURCE_CODE = YES
LATEX_BIB_STYLE = plain
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
MSCGEN_PATH =
DIA_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
DOT_NUM_THREADS = 0
DOT_FONTNAME = Gotham Rounded
DOT_FONTSIZE = 10
DOT_FONTPATH = .src/Gotham Rounded
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
UML_LIMIT_NUM_FIELDS = 10
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
INTERACTIVE_SVG = NO
DOT_PATH =
DOTFILE_DIRS =
MSCFILE_DIRS =
DIAFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = YES
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
Thanks in advance , and sorry for the long laundry list!
Ondine
------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
