Documentation for Modes

[joelmoniz]

Documentation for Modes should, perhaps, be done along the lines of how the documentation has been done for Libraries and Tools, on the Github wiki.

This issue is in reference to processing/1656.

[REAS]

Who is the best person for this job? @fjenett would you have a look?

[REAS]

I assigned @fjenett, but it's provisional.

[jeremydouglass]

Sorry that this doesn't exist--any reason we can't leave the issue open? I've seen several conversations recently about starting modes; maybe a new author could contribute as they learn-by-reverse-engineering existing modes.

Many moons ago, there was a template for a Processing 2.0 mode:

https://github.com/martinleopold/TemplateMode

I recorded some basics about the mode PDE distribution mechanism a while back when working on Processing.R

https://forum.processing.org/two/discussion/comment/113775/#Comment_113775

I'm assuming that anything new would go on https://github.com/processing/processing/wiki/ next to Library and Tool info, like:

• Mode Basics
• Mode Guidelines
• Mode Overview

[jeremydouglass]

Okay, I have completed a first draft, here:

https://github.com/processing/processing/wiki/Mode-Overview

Detailed information on developing and building is missing, but it includes an overview of concepts, survey of current modes, and an explanation of the distribution mechanisms and methods. Feedback greatly welcomed.

While we try to get more information on setting up an Eclipse template / building / testing added, it would be great to leave this issue open to direct help.

[jeremydouglass]

@prisonerjohn, feedback or edits on the later sections on distribution -- especially the section "List in PDE" -- would be most welcome.

https://github.com/processing/processing/wiki/Mode-Overview#list-in-pde-appearing-in-the-contributions-manager-for-install

[jeremydouglass]

Mode authors or maintainers -- such as @benfry @codeanticode @fathominfo @fjenett @gaocegege @jdf -- please contribute or just let me know if the Mode wiki section on languages and libraries has any mistakes or anything missing. It is not meant to be complete, but I don't want it to be misleading.

https://github.com/processing/processing/wiki/Mode-Overview#modes-languages-and-libraries

[jdf]

It looks great to me.

[prisonerjohn]

Thanks Jeremy, this looks really good!

About the "List in PDE" section, we definitely don't encourage people to edit sources.conf locally and submit PRs. The best way to add your Mode to the list is still to email me, as I need to review it and make sure it includes everything it needs before adding. It's best for me to be in touch with devs at this point so we can work together through any issues.

I would just change that text to read like the other contributions:

Once everything is in place, send your static links to the Processing Librarian: Elie Zananiri. We'll review your properties file to make sure everything is in order and add your contribution to the list of advertised libraries.

Otherwise, this is a nice update and we should integrate some of this text in the READMEs for Libraries and Tools. @jeremydouglass let me know if you're up for that, otherwise I'll happily do it.

[jeremydouglass]

Great, updated "List in PDE" accordingly.

Absolutely go ahead with using anything you like in Libraries / Tools if you have a plan for how -- or I suppose some could be spun off onto another page and referenced by all three.