On 20/03/12 22:37, [[w:en:User:Madman]] wrote:
Like most generated documentation, the audience is
more developers
than end users (I hope to do a better write-up soon for end users,
including what the core goals of the framework are, but I'm aware that
my progress is slow at the moment). All of the methods to use on an
Action or Query instance *are* listed, though; you can get variables,
set variables, and execute, and that's it.
"Documentation designed for libary developers, useless for developers
using the library" isn't a good slogan either :)
The variables you can get or set depend on what action
or query is
specified, but there is not a separate framework class for each action
or query. The variables are by necessity defined in the API
documentation (e.g.
http://www.mediawiki.org/wiki/API:Allpages)
I expected
something like that.
How are you doing the db backend? Are you loading MediaWiki and using a
FauxRequest?
and not the framework documentation; while I could
write up examples using
the framework for each type of action and query, I couldn't possibly
cover the sheer breadth of options that are available in the API.
Well, I'd expect a handful of examples from which the pattern would b
easy to infer, plus some explanation for when you need to use a new
module for which there's no example.
The point at the moment is that the framework
automagically handles
all prefixing of parameters, including generators' parameters, so the
end user's code is more readable; it also continues queries
automatically and selects an appropriate backend for actions and
queries (which is its primary purpose).
It even does more than I expected.
Does that make more sense?
Heh, I never doubted it was useful. I was just a bit.. deceived by the
documentation.
My point is, if I wanted to perform an api query which I had. I have no
idea how to do that with your library.
When should the parameters be prefixed and when not, for instance.
Not to mention if I wanted to translate a more complex query with a
generator, such as:
https://commons.wikimedia.org/w/api.php?action=query&generator=search&a…
Best regards