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.
Hi Kishan,
On 17 May, 2014, at 7:02 am, Kishan Thobhani thobhanikishan@gmail.com wrote:
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.
I’ve just realised that you can already do this if you know the name of the page, e.g. - http://en.wikisource.org/w/api.php?action=query&generator=allpages&g...
… which will return every page from “Love among the chickens (1909).djvu”, along with its proofread status. It would be nice to be able to look up both the page count (e.g. page 10, which is Page:Love_among_the_chickens_(1909).djvu/10) to the page name (which, according to the index page, is “Fpiece”), but I’m not sure anybody would actually *need* this. For my needs, the API call mentioned above would have been sufficient.
Also, may I also suggest you move https://www.mediawiki.org/wiki/Extension_talk:Proofread_Page#API_Documentati... to a subpage of the Extension page, maybe https://www.mediawiki.org/wiki/Extension:Proofread_Page/Documentation — talk pages are IMO intended for conversations, not for documenting things. I’d feel weird editing someone else’s content on a talk page!
cheers, Gaurav
Hey Gaurav,
This is good. I see you get page count along with the title though. Do you mean if we can somehow query this and get the page name for same? I was wondering if we have any other parameters to prop=proofread? Also i might be missing something here but whats gap prefix for? Because u don’t find much documentation for gapnamespace & gap prefix. i assume this just have to do with proofread.
Also don’t worry about adding your points on the talk page since we are just using to push conversation for API. Sort of like a draft. Its semi-official so once we have everything sorted we will move it to appropriate section.
On 18-May-2014, at 5:04 am, Gaurav Vaidya gaurav@ggvaidya.com wrote:
Hi Kishan,
On 17 May, 2014, at 7:02 am, Kishan Thobhani thobhanikishan@gmail.com wrote:
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.
I’ve just realised that you can already do this if you know the name of the page, e.g.
… which will return every page from “Love among the chickens (1909).djvu”, along with its proofread status. It would be nice to be able to look up both the page count (e.g. page 10, which is Page:Love_among_the_chickens_(1909).djvu/10) to the page name (which, according to the index page, is “Fpiece”), but I’m not sure anybody would actually *need* this. For my needs, the API call mentioned above would have been sufficient.
Also, may I also suggest you move https://www.mediawiki.org/wiki/Extension_talk:Proofread_Page#API_Documentati... to a subpage of the Extension page, maybe https://www.mediawiki.org/wiki/Extension:Proofread_Page/Documentation — talk pages are IMO intended for conversations, not for documenting things. I’d feel weird editing someone else’s content on a talk page!
cheers, Gaurav _______________________________________________ Wikisource-l mailing list Wikisource-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikisource-l
We are almost done with documenting API for Proofread Page Extension. https://www.mediawiki.org/wiki/Extension_talk:Proofread_Page#API_Documentati...
Please comment if we need to change / add anything.
@Thomas (tpt)
I don’t mind moving it to the Extension page. Is it okay? Im still getting familiar with protocol of doing this things officially. Beside i might need some help in generating translations for same.
wikisource-l@lists.wikimedia.org