prologdoc-devel Mailing List for PrologDoc
Status: Beta
Brought to you by:
bramadams
Menu
▾
▴
prologdoc-devel — Mailing list for communication between/to the PrologDoc development team.
You can subscribe to this list here.
| 2005 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
(1) |
Jul
|
Aug
(6) |
Sep
(2) |
Oct
|
Nov
|
Dec
|
|---|
|
From: Bram A. <bra...@ug...> - 2005-09-16 15:47:38
|
Hi, Op 16-sep-05, om 03:12 heeft Chris Mungall het volgende geschreven: > > The changes I mentioned previously on this list have been committed. Good work. > > I've also started a Changes file for logging any modifications to > the code I think you can generate these from the logging messages provided with CVS commits using a script found at http://www.red-bean.com/ cvs2cl/. > > Next up - a new home page, a new release candidate Alright. I'm currently struck by gland fever, so I won't be able to do much (did I ever ;-)) for several weeks (months?). I'll keep on reading the mailing list though ... Kind regards, Bram Adams > > > > > ------------------------------------------------------- > SF.Net email is sponsored by: > Tame your development challenges with Apache's Geronimo App Server. > Download it for free - -and be entered to win a 42" plasma tv or > your very > own Sony(tm)PSP. Click here to play: http://sourceforge.net/ > geronimo.php > _______________________________________________ > Prologdoc-devel mailing list > Pro...@li... > https://lists.sourceforge.net/lists/listinfo/prologdoc-devel > |
|
From: Chris M. <cj...@fr...> - 2005-09-16 01:13:00
|
The changes I mentioned previously on this list have been committed. I've also started a Changes file for logging any modifications to the code Next up - a new home page, a new release candidate |
|
From: Chris M. <cj...@ma...> - 2005-08-29 03:23:23
|
I've fixed the problem with the internal hrefs (thanks Salvador) still to commit the fixes, but I've updated the pdoc below.. On Thu, 25 Aug 2005, Chris Mungall wrote: > > I'm experimenting with a new style for pdoc generated html. This just > requires a simple addition to the xsl and an additional css file. Salvador > has done an excellent job on making the whole system extensible and > allowing easy configuration at different levels > > See what you think: > > Salvador's AVL code: > http://www.fruitfly.org/~cjm/blip/pdoc/avl.html > > Some of my modules: > http://www.fruitfly.org/~cjm/blip/pdoc/graph.html > http://www.fruitfly.org/~cjm/blip/pdoc/sb_db.html > http://www.fruitfly.org/~cjm/blip/modules.html > > As you can see, the predicate index is now in a left panel. I prefer this > to the default style where you have to scroll past a (potentially large) > index of predicates just to get the basic details on the module. > > (All this is being generated using prolog 5.4.7 which doesn't manifest the > previously mentioned problems) > > Cheers > Chris > > > ------------------------------------------------------- > SF.Net email is Sponsored by the Better Software Conference & EXPO > September 19-22, 2005 * San Francisco, CA * Development Lifecycle Practices > Agile & Plan-Driven Development * Managing Projects & Teams * Testing & QA > Security * Process Improvement & Measurement * http://www.sqe.com/bsce5sf > _______________________________________________ > Prologdoc-devel mailing list > Pro...@li... > https://lists.sourceforge.net/lists/listinfo/prologdoc-devel > |
|
From: Chris M. <cj...@fr...> - 2005-08-27 00:50:20
|
You're right This appears to be a problem when running pldoc with multiple pl files on the command line at once - it seems to be uniqueifying the ids of the verious sections by suffixing a number onto them. This is fixed by running pldoc seperately on each pl file. However, this is not an adequate solution, since my modules cross-reference one another. Salvador, I'm going to need your help to fix this one... Chris On Fri, 26 Aug 2005, Bram Adams wrote: > Hi, > > Chris Mungall wrote: > > >I'm experimenting with a new style for pdoc generated html. This just > >requires a simple addition to the xsl and an additional css file. Salvador > >has done an excellent job on making the whole system extensible and > >allowing easy configuration at different levels > > > >See what you think: > > > >Salvador's AVL code: > >http://www.fruitfly.org/~cjm/blip/pdoc/avl.html > > > >Some of my modules: > >http://www.fruitfly.org/~cjm/blip/pdoc/graph.html > >http://www.fruitfly.org/~cjm/blip/pdoc/sb_db.html > >http://www.fruitfly.org/~cjm/blip/modules.html > > > > > Looks very good, except that in the index only the hyperlinks starting > from the Predicates section are working. The XML part indeed allows for > easy customization. > > Cheers, > > Bram Adams > |
|
From: Bram A. <bra...@ug...> - 2005-08-26 07:09:09
|
Hi, Chris Mungall wrote: >I'm experimenting with a new style for pdoc generated html. This just >requires a simple addition to the xsl and an additional css file. Salvador >has done an excellent job on making the whole system extensible and >allowing easy configuration at different levels > >See what you think: > >Salvador's AVL code: >http://www.fruitfly.org/~cjm/blip/pdoc/avl.html > >Some of my modules: >http://www.fruitfly.org/~cjm/blip/pdoc/graph.html >http://www.fruitfly.org/~cjm/blip/pdoc/sb_db.html >http://www.fruitfly.org/~cjm/blip/modules.html > > Looks very good, except that in the index only the hyperlinks starting from the Predicates section are working. The XML part indeed allows for easy customization. Cheers, Bram Adams |
|
From: Chris M. <cj...@fr...> - 2005-08-25 21:42:59
|
I'm experimenting with a new style for pdoc generated html. This just requires a simple addition to the xsl and an additional css file. Salvador has done an excellent job on making the whole system extensible and allowing easy configuration at different levels See what you think: Salvador's AVL code: http://www.fruitfly.org/~cjm/blip/pdoc/avl.html Some of my modules: http://www.fruitfly.org/~cjm/blip/pdoc/graph.html http://www.fruitfly.org/~cjm/blip/pdoc/sb_db.html http://www.fruitfly.org/~cjm/blip/modules.html As you can see, the predicate index is now in a left panel. I prefer this to the default style where you have to scroll past a (potentially large) index of predicates just to get the basic details on the module. (All this is being generated using prolog 5.4.7 which doesn't manifest the previously mentioned problems) Cheers Chris |
|
From: Chris M. <cj...@fr...> - 2005-08-24 20:38:57
|
PrologDocNG works fine on 5.4.x, but a difference in default operators
seems to be causing problems for 5.5.x; I get a slew of errors like this:
ERROR: /Users/cjm/cvs/PrologDocNG/src/tags.pl:156:0: Syntax error:
Operator expected
ERROR: /Users/cjm/cvs/PrologDocNG/src/tags.pl:247:0: Syntax error:
Operator expected
...
All these lines include a term with ? as functor. Indeed, after testing it
seems that 5.4.x defines an op for ?, but 5.5.x does not
I explicitly defined the ? operator as a prefix with what the swipl docs
says should be the default precedence, like this:
diff -r1.3 tags.pl
36a37
> op(500, fx, (?)), % CJM
44a46
> :- op(500, fx, (?)). % CJM
And pldoc runs without complaining.
However, the xml that is produced (under 5.5.x) has some severe oddities.
Using prologdocng with 5.5.x introduces duplicate predicate elements in
the xml for pdoc comments of the following form:
/**
@pred avl_empty(?Tree)
creates an empty AVL tree.
*/
(taken from PrologDocNG/samples/avl.pl)
In the generated xml, the predicate is listed twice - first as
avl_empty(?Tree) then as avl_empty/2. Only the first has the predicate
description attached. (see attachments)
I don't know what could have changed in 5.5.x to introduce this behaviour.
I am not sure if it is related to operators, or something completely
different. (My operator fix produces the correct behaviour on 5.4.x, for
what it's worth)
Until the code is fixed, my only options are:
(1) redocument all my code like this:
/**
@pred avl_empty/1
@mode avl_empty(?Tree)
creates an empty AVL tree.
*/
this produces the correct output. I would rather not do this, as I have a
lot of existing documentation where I mix @pred and @mode
(2) use 5.4.x for running pldoc
This is what I'll do in the short term, but it isn't a viable long term
solution, especially as Jan prepares to release 5.6 (including
PrologDocNG?)
Any ideas?
Thanks
Chris |
|
From: Chris M. <cj...@fr...> - 2005-08-04 21:59:03
|
I notice that PrologDocNG is now part of the SWI source distribution - great stuff! This seems to be an older version than what's in cvs - I think it's 1.0RC2. Shall we make a RC3 with the latest code - or just bite the bullet and get a full 1.0 out? |
|
From: Bram A. <bra...@ug...> - 2005-06-12 21:12:12
|
Hi, Chris Mungall wrote: >The code seems very stable, and I've used it extensively > >I have a few changes I would like to commit to support codelistings (a >new @cl tag) - shall we discuss these on the prologdoc-devel list? > >You can see an example here: >http://www.fruitfly.org/~cjm/blip/pdoc/graphviz.html > >And more here: >http://www.fruitfly.org/~cjm/blip/modules.html > > Seems useful to me. What are the technical consequences, Salvador (I need to delve into the source code again ...)? >There are a few changes I'd like to see, but don't really know the code >well enough to implement - in particular, I would like to preserve the >ordering of predicates I have in my source (pdoc currently sorts these >alphabetically) - my docs often have some linear flow > > Would it be interesting to assign priorities to comments too? All comments with same priority level could be listed alphabetically (maybe with their own heading). By using a switch tag in the file comment, the relevant ordering (completely alphabetically, ordering from file or priority ordering) could be chosen. Could this behavior be implemented solely in XSLT? >I think before we have a release we need at minimum a home page that isn't >misleading. There's a chance I may be able to work on this in the next >month > > OK, it needed a revamp badly ;-)! > > >>So Salvador, can you brief us about PrologDocNGs current form and any >>necessary, but lacking features? Chris (everybody in fact), what's your >>vision about PrologDoc's future? Any other remarks (role assignment, >>collaboration model, ... )? >> >> > >I'm happy to help out coding and with documentation in so far as time >allows. I'm happier working around the edges on things such as the xslts >since I'm not familiar enough with the guts of the code to do much else >(ironically the pdoc internals could really do with a bit more >documentation!) > > Good suggestion. Salvador, if time allows, I'll try to explore the source code. Could you provide us a high-level overview of the current architecture? >Does someone want to respond to the question on the swi list? > > I think Salvador is subscribed to that mailing list. But, apparently someone else has already responded. Kind regards, Bram Adams |
