Thank you for all the inputs.
I have documented an abstract version here,
http://www.mediawiki.org/wiki/Extension_talk:Proofread_Page#API_Documentatio...
At some places i have placed <Need more input pointer> so if anyone has any knowledge about same, please fill in it would be really great if we can document as much as we can with more perspective. Examples & information in this section right now is more or less referenced from http://wikisource.org/w/api.php
You can shoot your views in here too. I’ll take care to cross reference it in the draft.
I would like everyone to have a look at TBTs thoughts here, https://www.mediawiki.org/wiki/Extension_talk:Proofread_Page#w.r.t_IRC_chat
TBT suggest we should specify format specification of how we format output. Currently prp just supports wikitext. If you anyone would like to expand on this point or give some view on TBT point that would be great. Over a brief conversation with TBT, he also suggested that we should serialise output in JSON format? Thank you TBT for this.
@gaurav vadia
You can do a lot with ProofreadPage without any new APIs. For example, I wrote a Perl module to download an entire book from the English Wikisource as WikiText two years ago. At that time, I implemented it for a hypothetical “Index:Entire book.pdf” by:
- Using prop=imageinfo to get the number of pages for “File:Entire book.djvu".
- Using prop=revisions to download the Wikitext for each individual page from “Page:Entire book.djvu/1” to “Page:Entire book.djvu/9999” (if the image had 9,999 pages).
This will work for Wikisources that redirect “File:”, “Index:” and “Page:” into their local namespaces. I ignored the proofread status entirely, since all the pages I needed to download had already been transcribed, but I guess it might be helpful to have an API query that could return the proofread status for every page in an Index page. That’s the only idea I have for now!
Do you think it would be possible to create a small example of same in terms of proofread hooks? It could be just API calls. So that we can mention it in example sections.
@ thomas tanon
Feel free to start a page describing what the two API hooks do with a simple example as it's done in pages like [0]. It would be a nice basis for other people to share their use cases.
Yes i have created an section on http://www.mediawiki.org/wiki/Extension_talk:Proofread_Page#API_Documentatio... but it needs massive improvements. Im still not sure about parameters. But there is likely that there as an scope to improve on API and provide more flexibility if we start here.
Thank you everyone.