Allegro.cc - Online Community

Allegro.cc Forums » Allegro.cc Comments » online manual updated

This thread is locked; no one can reply to it. rss feed Print
online manual updated
Matthew Leverton
Supreme Loser
January 1999
avatar

The online manual has been updated to 4.2.1. The duplicate return values and missing cross reference bugs have been fixed.

Also, each page now contains a list of "related" forum discussions. The threads are currently just listed in descending order and are not updated real-time. If I ever feel like it, I'll implement a more relevant sorting method.

kazzmir
Member #1,786
December 2001
avatar

Attaching forum threads to documenation is a really good idea. The only thing that comes close is the single threaded discussion on php.net. But I like your idea better.

BAF
Member #2,981
December 2002
avatar

I think adding a thread like php.net is nice too. I find a lot of neat snippets and such in the php.net threads, and that could be really neat here on a.cc.

Marco Radaelli
Member #3,028
December 2002
avatar

I tried a couple of pages and each one has a small issue generating a warning in Tidy (integrated in Firebugs):

<div id="header">
<a href="/"><img src="/theme/default/image/logo.png" alt="logo" width="293" height="56" border="0" width="293" height="56" border="0" /></a>
</div>

Line 19, the img attributes are repeated.

There's another one, in "See also" boxes, some links have a white space in them, rather than %20 :)

Anyway, I like the new idea :)

Thomas Fjellstrom
Member #476
June 2000
avatar

Quote:

I find a lot of neat snippets and such in the php.net threads, and that could be really neat here on a.cc.

Which is why it links to related threads :P

--
Thomas Fjellstrom - [website] - [email] - [Allegro Wiki] - [Allegro TODO]
"If you can't think of a better solution, don't try to make a better solution." -- weapon_S
"The less evidence we have for what we believe is certain, the more violently we defend beliefs against those who don't agree" -- https://twitter.com/neiltyson/status/592870205409353730

BAF
Member #2,981
December 2002
avatar

Yes, but a feature like the php.net threads would be better (a running list of relevant code snippets, instead of what seem to be vaguely relevant problems or questions).

CGamesPlay
Member #2,559
July 2002
avatar

Very cool. I like it a lot. Could you maybe give me the SQL dump of the documentation, so I can import it into my IRC bot?

--
Tomasu: Every time you read this: hugging!

Ryan Patterson - <http://cgamesplay.com/>

Dustin Dettmer
Member #3,935
October 2003
avatar

Any chance you'll fix the bug with multiple functions with a single doc entry?

Thomas Fjellstrom
Member #476
June 2000
avatar

Unfortuneatly that has to do with the way the docs are layed out. I made my parser just duplicate the contents for functions that were declared with only one newline between them.

heres the actual docs for all the get[rgba][8,15,16,24,32,] functions.

--
Thomas Fjellstrom - [website] - [email] - [Allegro Wiki] - [Allegro TODO]
"If you can't think of a better solution, don't try to make a better solution." -- weapon_S
"The less evidence we have for what we believe is certain, the more violently we defend beliefs against those who don't agree" -- https://twitter.com/neiltyson/status/592870205409353730

Matthew Leverton
Supreme Loser
January 1999
avatar

Quote:

I think adding a thread like php.net is nice too. I find a lot of neat snippets and such in the php.net threads, and that could be really neat here on a.cc.

The PHP manual is full of crap, ten year old comments that were bogus to begin with.

Quote:

Any chance you'll fix the bug with multiple functions with a single doc entry?

No. First off, if someone cannot tell what getr24() does, he shouldn't even own a compiler. The Allegro documentation is written in a haphazard format. There's no way to tell, other than by (probably a safe) assumption, that 10 functions are grouped together. Even if I were to copy the description to each function, it'd end up like:

Quote:

Given a color in the format being used by the specified color depth, these functions extract one of the red, green, blue, or alpha components (ranging 0-255).

and then the same people who are confused about getr24 would now be confused about why functions is plural and that it says it extracts one of those four things.

The real solution is to edit the allegro._tx and include an individual description for each function like:

getr - extracts the red component
getb - extracts the blue component

And that, anyone can do.

Quote:

Could you maybe give me the SQL dump of the documentation, so I can import it into my IRC bot?

Most of it is just in flat html files. Attached is an XML conversion of the allegro._tx file. It should be a billion infinities easier to work with than the original mess.

Thomas Fjellstrom
Member #476
June 2000
avatar

My parser can output xml as well, with some bug fixes for things like this empty doc issue ;)

--
Thomas Fjellstrom - [website] - [email] - [Allegro Wiki] - [Allegro TODO]
"If you can't think of a better solution, don't try to make a better solution." -- weapon_S
"The less evidence we have for what we believe is certain, the more violently we defend beliefs against those who don't agree" -- https://twitter.com/neiltyson/status/592870205409353730

Audric
Member #907
January 2001

The "Voice control" link in the following page:
http://www.allegro.cc/manual/api/digital-sample-routines/voice-control/voice_set_frequency
leads to a dead link:
link
which gets redirected to the Manual home.
Space in URLs strikes again?

Matthew Leverton
Supreme Loser
January 1999
avatar

It's just that I don't store that deep of nested sections as a reference. You'll see the page here:

http://www.allegro.cc/manual/api/digital-sample-routines/

I've manually added that sub-section as a dummy section with a dead parent so that the link will work.

Audric
Member #907
January 2001

It works, thank you.
I posted here because the news mentioned "missing cross reference bugs"
Manual manual update = double chore :(

Go to: