Hm – that being said, chiming in as a casual user – I've wondered before whether a tex(t) source of the PDF is available.

No question: MPG is one of the best piece of documentation I've ever had the pleasure of reading. The breadth and depth and coherence really are an impressive accomplishment.

The underlying expectation, though, is that users read it like a textbook – when realistically people just want to google their problem, click, immediately be in the right section, aha, click, there's the link to the function reference, click, open a new tab, etc. When you work with a system as large as Gecode for a few days, constantly going back and forth between scrolling through a massive PDF and looking for corresponding doxygen pages becomes a bit tedious.

Yes, a total luxury complaint. I also get that you're worried about a bunch of different versions of the docs floating around. Just maybe if you publish the source people can experiment with pandoc-ing it straight into a doxygen or Sphinx format, and perhaps it'll become apparent that they really find that easier to use?

Sebastian


On 2017-01-19 09:36 AM, Christian Schulte wrote:
What? That is a real luxury complaint...

You know how much work it is to write a coherent 500 page document? That's
not that easy to do as html.

And searching in PDF is not that hard...

Christian

--
Christian Schulte, www.gecode.org/~schulte
Professor of Computer Science, KTH, cschu...@kth.se
Expert Researcher, RISE ICT/SICS, cschu...@sics.se


-----Original Message-----
From: users-boun...@gecode.org [mailto:users-boun...@gecode.org] On Behalf
Of Johannes Waldmann
Sent: Thursday, January 19, 2017 15:19
To: users@gecode.org
Subject: Re: [gecode-users] Number of solutions

... you should read MPG, really

Seconded. But - (Downloading and) opening a 500 page PDF is rather heavy. Is
there a HTML version, on the web somewhere, with URLs for sections, so that
it's easy to refer to?

I know there is "online HTML" doc at
http://www.gecode.org/documentation.html
but this refers to the C++ API only (?)
E.g., when I search for "command line"
(expecting to find something towards the answer you gave, "commandline
-solutions 0 -mode stat"), this is not really helpful:
http://www.gecode.org/doc-latest/reference/search.php?query=command+line

- J.W.


_______________________________________________
Gecode users mailing list
users@gecode.org
https://www.gecode.org/mailman/listinfo/gecode-users



_______________________________________________
Gecode users mailing list
users@gecode.org
https://www.gecode.org/mailman/listinfo/gecode-users


_______________________________________________
Gecode users mailing list
users@gecode.org
https://www.gecode.org/mailman/listinfo/gecode-users

Reply via email to