On February 21, 2013 08:53:28 AM Robert Jonsson wrote:
> Hi guys,
>
> 2013/2/21 Orcan Ogetbil <[email protected]>:
> >>> I built the docs last night several times, using ConText then pdflatex
> >>>
> >>> then texi2pdf each with no problem.
> >>>
> >>> What command did you use to build it?
>
> Ah, yes, I'm a fool. I tried with latex. Actually thought I had tried
> with pdflatex but probably not, trying not it worked fine.
Er, actually you probably weren't running from the doc directory?
So it couldn't find the pics.
I wrote:
>Tonight I will try to eliminate the dependency on Doxygen, since
> the HTML docs that MusE currently builds from the old/muse.sgm file
> are waaaay out of date, so I think we can trash them now.
Yikes! All these years MusE has required Doxygen -
and it wasn't even used for anything! The old .sgm file isn't even compiled!
The old HTML docs are pre-fab in /share/html and just simply installed!
So Doxygen was totally useless!
I removed it completely here.
Instead I used find_package(LATEX) and created a CMakeLists.txt
file in the doc folder. The file looks like this:
=================================
#
# Run the pdf converter at least three times to resolve cross-refs
#
if (ENABLE_PDF_DOCUMENTATION AND PDFLATEX_COMPILER)
add_custom_target(build_docs ALL
${PDFLATEX_COMPILER} -output-directory=${PROJECT_BINARY_DIR}/doc
${PROJECT_SOURCE_DIR}/doc/documentation.tex
COMMAND ${PDFLATEX_COMPILER} -output-directory=${PROJECT_BINARY_DIR}/doc
${PROJECT_SOURCE_DIR}/doc/documentation.tex
COMMAND ${PDFLATEX_COMPILER} -output-directory=${PROJECT_BINARY_DIR}/doc
${PROJECT_SOURCE_DIR}/doc/documentation.tex
COMMAND ${PDFLATEX_COMPILER} -output-directory=${PROJECT_BINARY_DIR}/doc
${PROJECT_SOURCE_DIR}/doc/documentation.tex
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/doc
)
endif (ENABLE_PDF_DOCUMENTATION AND PDFLATEX_COMPILER)
=================================
I'm just not entirely sure if I should use
add_custom_target() or add_custom_command().
Similar lines (not shown) for the HTML docs, except just single-run.
Latex2html tells me there is no documentation.aux file, so links are just
little 'squares'. Weird, pdflatex is the one that generates that .aux file.
I allow both PDF and HTML but this might (must?) change (see why below).
Having success building new docs from our cmake scripts.
Will commit tomorrow or so, depending on responses here.
>
> >> pdflatex is pretty much the standard. I used for my thesis; still use
> >> it for letters, papers etc. I am pretty sure there is an easy way to
> >> do it in cmake. Don't know how (yet) though. I'll take a look.
> >
> > I added some fancy features to the documentation, such as table of
> > contents and hyperrefs.
> > hyperrefs allow you to click on the PDF file to launch a browser to go
> > to a link directly. They also help jumping around the PDF file by
> > clicking on the "\ref" references, e.g. to sections, figures.
> > I also fixed some formatting issues.
Thanks Orcan! Nice work.
I'm not crazy about the red and blue surrounding boxes though.
I hope pdflatex allows us to tweak these things to use underlines etc.
> >
> > Before building, I recommend removing all the temporary files from the
> > doc/ directory (basically remove everything but the .tex file). Then
> > run
> > $ pdflatex documentation.tex
> > at least 3 times. This will sort out all the references and labels.
>
> You mean knocking your heels together three times? ;)
>
> Upon running it just once I got no toc, did it two times more and now
> the toc is there. I refuse to be amazed ;)
Good grief, is there no way to tell pdflatex to do this for us?
As you can see above I had to tell cmake to arbitrarily build it four times
(four for good luck). If not, hopefully some return code from pdflatex that
we can use?
Anyway I leave you with some thoughts...
Should we pick PDF or HTML only and stick with it?
Because if we allow the user to choose both or either, that
complicates what should happen when the user hits F1 for help.
And if we ever try to do context-sensitive help we'll need two
different systems - one to cross-ref PDF and one for HTML.
Got some ideas for context-sensitive help. How 'bout you?
For HTML, should we do one big file or many small ones?
Or give the user yet another cmake option?
I tried both and I prefer the one big file (latex2html -split 0), but then
this could get really big over time, but then so is the single PDF.
Many small files is kinda silly, you end up with little pieces of text
and the user has to click forward/backward a lot. Rather incoherent.
Till tomorrow. G'night.
Tim.
>
> Thanks!
> Robert
>
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_d2d_feb
_______________________________________________
Lmuse-developer mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/lmuse-developer
