Re: Plea to help flag docs

Thanks Alan,

On 07/11/2013 06:40 PM, Alan Baljeu wrote:
> I don't use the online help because the PCE help is much nicer.

Hmm.  That was not the idea.  Actually, the idea was to drop it,
hopefully fairly soon.

> First thing needed in the online is a synchronized tree of contents
> on the left side.  If I go here: 
> http://www.swi-prolog.org/pldoc/man?section=navigator
> 
> I don't get much information, and no context to move forward or
> backwards.

It is simply a very limited section.  But, the top-left is always a
link `up'.  If you click there, you get an overview of the section.

> If you add the navigation tree, I would actually use the online help,
> and then I can start tagging.

We'll see how Anne and Jessica will reshape the page :-)  More navigation
has been asked before, so I guess something is missing there.

> In addition, I would dearly love to add see-also links, because it's
> quite frequent that I'm trying to achieve a task and don't realize
> the ideal predicate for that task is not the one I'm looking at but
> elsewhere.

There are quite a few see-also links in the text.  Surely there can still
be more.  So, one thing you have is the link `up' that gives you the manual
section of the predicate which may provide see also links in closely related
predicates or the section introduction.

Using the comment editor, you can add "@see name/arity" to create additional
links.  To demo this, I just added a link to the section you mention

Hope this helps.

	Cheers --- Jan

> 
> Alan Baljeu
> 
> 
> 
> 
> On Fri, Jul 5, 2013 at 8:00 PM, Anne Ogborn <[email protected]>
> wrote:
> 
>> A plea to help with documentation.
>> 
>> If you find the documentation for a predicate confusing, please tag
>> it with the doc-needs-help using the new tagging system on
>> www.swi-prolog.org
>> 
>> When there's enough of these tagged and we find resources to do it,
>> we'll have a push to clean up the docs.
>> 
>> A general  cleanup of the site organization, etc. is underway. I
>> started doing this last fall, but was sucked into a contract. I've
>> been desucked and am back on the site.
>> 
>> So tag away folks! _______________________________________________ 
>> SWI-Prolog mailing list [email protected] 
>> https://lists.iai.uni-bonn.de/mailman/listinfo.cgi/swi-prolog
>> 
>> 
> -------------- next part -------------- HTML attachment scrubbed and
> removed _______________________________________________ SWI-Prolog
> mailing list [email protected] 
> https://lists.iai.uni-bonn.de/mailman/listinfo.cgi/swi-prolog
> 
> _______________________________________________ SWI-Prolog mailing
> list [email protected] 
> https://lists.iai.uni-bonn.de/mailman/listinfo.cgi/swi-prolog
>