New Docs, new layout

new topic     » topic index » view thread      » older message » newer message

When adding many new functions and then trying to document those functions, then
with the addition of new includes using namespaces, the current method of
grouping the function reference by A-B, C-D, etc... became very difficult. I
spoke to Rob and with his blessing, I've changed the way the documentation works
a bit. I will update the doc processing before the release of 3.2/4.0 to include
an alphabetical index of all functions, but that is not there yet.

The new docs add's a navigation toolbar to the top and bottom of the library
reference, and it also groups functions by their functional group, not by
alphabetical order. So, on one page, you can view all the functions dealing with
sequences. On another page, you can view all the functions dealing with the
operating system, etc...

The library page is still there that lists all the functions with a short
description grouped by their functional type.

I have compiled the new documentation and placed it on my web server for others
to view and comment on. Here are a few key URL's you will want to visit:

Starting point:
    http://jeremy.cowgar.com/euphoria/overview.htm

Where things begin to change:
    http://jeremy.cowgar.com/euphoria/library.htm

Where you can see a functional grouping page instead of an alphabetical
grouping:
    http://jeremy.cowgar.com/euphoria/lib_math.htm

This is a rough draft, so please let me know what you think.

--
Jeremy Cowgar
http://jeremy.cowgar.com

new topic     » topic index » view thread      » older message » newer message

Search



Quick Links

User menu

Not signed in.

Misc Menu