WK Add-on Project - Let's all get involved


#1

皆さん、こんにちは ^_^

How to take part


Developers/Add-on Authors
- Add your own add-on’s https://github.com/eddie/wkindex/tree/master/scripts
- Verify your add-on has correct information https://github.com/eddie/wkindex/tree/master/scripts
- Help out with the lint tool for verifying data https://github.com/eddie/wkindex/blob/master/lint.py

Non-Developers
- Help out with wiki documentation https://github.com/eddie/wkindex/wiki
- Help out with the readme https://github.com/eddie/wkindex/blob/master/README.md
- Suggest ideas or report inconsistencies https://github.com/eddie/wkindex/issues
- Spread the word on twitter, or to friends who use WK.

Curious
http://eddie.github.io/wkindex/


Today I had some time away from work, and was going to build a project I’ve wanted to build for a while… A searchable index of WK add-ons, browser extensions and apps… But I soon realised the data wasn’t out there in an accessible format… I believe this is why the add-on ecosystem is so fractured and messy…

Eventually I think it would be great to have a community index where we  can add scripts etc, and are not at the mercy of WK’s Forum search and userscripts being down… hoorah  I dream of a future where we don’t have to go to the last page of a script thread to find a version that works… hoorah

But in order to build this, we need a platform to work from… Some initial data or a way to gather the data. So today, I started a project.

https://github.com/eddie/wkindex

My initial plan was to go through by hand and add the data myself, I even considered building a scraper to help me with the process… But I work for a startup, I am learning Japanese (like all of us here) and have a family to look after at the same time… So time is hard to find recently.

The WK community is made up of many talented people, and I’m sure that if we can all put a little time into this project we can make it easier for existing members and new comers to WK.

Comments, thoughts,  criticisms are all welcome :slight_smile:

お願いします!

Edit: Big thanks to everyone who has contributed already, even a simple post on here helps!







List of API and Third-Party Apps
#2

I’ve started a script/extension to help make the studying experience (between reviews) a little nicer:

a) Hides the hiragana and English on radicals/kanji/vocab until you hover over it.  This makes it easier to go down the list item by item and test your memory, without accidentally seeing the answer for the next item.


b) Sorts the vocab, so that words with the same starting kanji are grouped together, and moves locked items to the end of the list.


I haven’t had time to learn how to make a configurable interface yet, e.g. for an enable/disable button, or for different sort criteria.  But if anyone is interested in the extension/script as-is, I would be happy to share.  Hopefully, I’ll have a chance to finish it and post on Google Play, but in the meantime I’m spending my free time helping our Japanese exchange student understand U.S. History (so many obscure words and antiquated English phrases… argh!!)


#3
rfindley said... I've started a script/extension to help make the studying experience (between reviews) a little nicer:

{snipped}

 haven't had time to learn how to make a configurable interface yet, e.g. for an enable/disable button, or for different sort criteria.  But if anyone is interested 中the extension/script as-is, I would be happy to share.  Hopefully, I'll have a chance to finish it and post on Google Play, but 中 the mean time I'm spending my free time helping our Japanese exchange student understand U.S. History (so many obscure words and antiquated English phrases... argh!!)

rfindley at usa dot net
 Aaah I would love that! And goodluck on the turtoring!

And Eddie thanks! This is a great idea!! I'll help add some things to the index now.

#4

[accidentally posted twice oops}


#5

Sweet! I was thinking about the sorry state of affairs just this morning. I’ll submit my stuff later.


#6
rfindley said... I've started a script/extension to help make the studying experience (between reviews) a little nicer:

a) Hides the hiragana and English on radicals/kanji/vocab until you hover over it.  This makes it easier to go down the list item by item and test your memory, without accidentally seeing the answer for the next item.

。。。

I haven't had time to learn how to make a configurable interface yet, e.g. for an enable/disable button, or for different sort criteria.  But if anyone is interested in the extension/script as-is, I would be happy to share.  Hopefully, I'll have a chance to finish it and post on Google Play, but in the meantime I'm spending my free time helping our Japanese exchange student understand U.S. History (so many obscure words and antiquated English phrases... argh!!)

findley-wanikani at usa dot net
 Nice work! If you put it online, feel free to add your project to https://github.com/eddie/wkindex/tree/master/scripts :)

BlaiddDrwg said.
And Eddie thanks! This is a great idea!! I'll help add some things to the index now.

looki said... Sweet! I was thinking about the sorry state of affairs just this morning. I'll submit my stuff later.
 
Thanks looki, BlaiddDrwg! Much appreciated :)

Thanks for the support guys, this is something I really want to make available for everyone, even a single small pull request will make a difference :)





#7

I just wanted to say thanks for getting this started. I think it’s a great idea! I’ll see if I can add anything later on.


#8

Alright just sent a push full of apps and games to the index! I tried to link to the forum posts as often as I could in the source field. Maybe add another field just for the wanikani forum posts? Then I could add the source, home, and forum pages.

Tell me if I need to fix anything I pushed and I’'ll work on it later today (I also have a few more that I could add but I’ll get to it a bit later when I have more time)

Thanks again!


#9

First pull request merged, awesome! thanks BlaiddDrwg :slight_smile:

Blaidd, feel free to make suggested schema changes as a pull request, or open an issue and we can all have some input on it.

I think we need to set some allowed values for fields such as “type” and “supported”… I’ll do somework on this tomorrow if no one else has :slight_smile:

Cheers!



#10

Opened an issue on some suggestions on values and a possible OS field that could help with some value potential clutter :slight_smile: this is going great so far!


#11

すごい, good suggestions!

Discussion is here for anyone who want’s to add their input https://github.com/eddie/wkindex/issues/2

I’ve just normalized the date formats… I think it will be a bit bumpy to start with as we agree on formats, but hopefully things will level out and soon we will have a lovely source of data to play with  :slight_smile:


#12

This might be useful: /t/List-of-API-and-Third-Party-Apps/5495/1


#13
nqthqn said... This might be useful: /t/List-of-API-and-Third-Party-Apps/5495/1

 Holy crap that's great! Thanks for sharing!

#14

seems to me like a very good idea!


#15
nqthqn said... This might be useful: /t/List-of-API-and-Third-Party-Apps/5495/1

 Thanks nqthqn, I actually already extracted the links from that thread https://github.com/eddie/wkindex/blob/master/common-addons.csv :)


#16

Any python developers want a project? Feel free to work on the lint.py tool for managing are data :slight_smile:

https://github.com/eddie/wkindex/blob/master/lint.py

Any wordsmiths who arn’t familiar with git feel free to add to the wiki

https://github.com/eddie/wkindex/wiki

And any wordsmiths, organization nuts who are familiar with git, feel free to help out with the readme :slight_smile:

https://github.com/eddie/wkindex/blob/master/README.md

Thanks all




#17

Got a long way to go, but iamale has been a massive help in getting the site development started, defining the app schema etc…  Thanks iamale!

Lot of work to be done, so if you can help in anyway, please do :slight_smile:

http://eddie.github.io/wkindex/


#18

Hey, awesome! That already looks really nice.
 I think I’ll have to step down from contributing for a while, I really should focus on my exams. sigh
Afterwards I’ll probably help out with the interface.


#19

:slight_smile: Thanks for your contributions so far looki

And cool, no worries… I’m in the same situation but instead of exams, work… So I’m trying to do a little where I can… Good luck with your exams, 頑張って!

Cheers!


#20

This sounds awesome! Thanks for getting this started!
I’ve just started learning to program, so hopefully I can contribute in the future! (Might be a distant future mind)