This topic should be about discussing the (re-)structuring of the imagej.net wiki page in relation to the developer part of the page. Final aim is to get a clearly structured step-by-step guide for plugin developer newbies in how to start writing their plugins in the ImageJ2 code structure.
If this should rather be discussed on an IJ guide gitter channel or so, let me know to migrate it there.
Many of these things might be very clear to experienced programmers, but for newcomers I think it is difficult to see the clear path from their initial idea to their final running plugin in “virtual brain code” so far.
This should not be a critisism on all the immense amount of already existing information but rather a starting point for things to add in the future. Actually, the revised version of http://imagej.net/Development looks nicely structured. What I will mention below would now fit to the final point and there actual to the “Writing ImageJ2 Plugins” part.
This should include for example some statements on the changes regarding some term definitions (which currently still confuses me) and the sequence to follow starting learning IJ2-programming from scratch. Advanced users still can skip individual sections which they consider too basic.
Here some loose ideas for the moment (I might have missed an existing explanation for what I am listing here, but this would show that it might not be obviously accessable):
- why is a plugin now called a command and what kind of command do actually exist (something which is somehow partially digged in the the javadocs, but you need to find and cherry-pick it).
- why do we now have Services and how can the functionality of a service be perceived best from a beginners point of view.
- adding an example tutorial on how do I implement/use a Service (if not already existing).
- what are all the possible annotations (potentially including their parameters, but this can actually also be looked up in
- generally it gets more complicated, because the programmer might need to work with different Javadocs. So, when do I need which JavaDoc and with which information should I start best if I have no clue? This is a little bit like the structure from Christian in the hackathon doc.
- a sorted list of the links to the existing tutorials on git which then still needs to be updated with additional tutorials (also some even more basic ones, I’ll try to create some on my way learning this)
So, I hope I didn’t just list things which are already existing and I am just too clumpsy to find and assemble them. If so, ignore my topic and bash me with those URIs