Re: [twdev] I wrote a plugin and I've no idea how to publish it

[Akira D]

I would Use the license for tiddlywiki or GPL, any disagreements? 

Sent from Akira's iPad

On Jul 2, 2012, at 5:35 AM, mni <scz...@gmail.com> wrote:

Hi Group!

I wrote a plugin (my first one) yesterday and I want to share it anyhow. Unfortunately I've no idea how to do so, I wust just very lucky that I've finished it at all...

Things that are on my mind:

• What would be an appropriate license?
• How to export the tiddler?
• How/where to publish?
• Has the plugin all descriptions necessary for publishing?

Any help/advice would be greatly appreciated.

Cheers,
mni

--
You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.
To view this discussion on the web visit https://groups.google.com/d/msg/tiddlywikidev/-/89YLftcINkkJ.
To post to this group, send email to tiddly...@googlegroups.com.
To unsubscribe from this group, send email to tiddlywikide...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/tiddlywikidev?hl=en.

[PMario]

There are different commonly used license types for TW plugins. I did
some comments below every item. The comments are my opinion, which may
be wrong :)

My opinion is, if you use a more liberal license, the chance to be
adopted is higher.

TiddlyWiki and many plugins (from Osmosoft) are BSD licensed.

Several 3rd party plugins, including mine, are a type of
CreativeCommons CC-, wich imo is quite nice due to the configurator.
So you can start with a strict license, and later on make it more
liberal, without compatibility problems.

If I think my plugins should be able to be included into the core some
time, they need to be at least BSD.

====
most liberal single licenses first:

MIT [1] license.
The users basically can do what they want. The copyright notice
"shall" be included. imo the important stuff is "THE SOFTWARE IS
PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND" which keeps you safe.

BSD [2]
Similar to MIT but the copyright notice needs to be included. SOFTWRAE
"AS IS " ...

CC-BY [3]
This is the least rescricted of the CC-type licenses which have a nice
configurator [4].
All of them may be appropriate as long as you "Allow modifications of
your work?". If someone sets modifications to "no", I personally think
it is unusable in a TW context.

The more restrictions you add, the less "attractive" the plugin is.

GPL type [5][6]
They are all quite long and restrictive, compared to those above.
Since

==quote from [6]==
The GPL is the first copyleft license for general use, which means
that derived works can only be distributed under the same license
terms.
==end quote==

This forces big companies to use the same terms for there modified
sources. So they need to give the source back to the community. Which
is good for the community. But it forces you to use the same license
if you use only parts of a plugin.

In my opinion GPL for TW plugins is overkill.

===========

dual or more licenses
like jQuery stuff [7]
Is a very liberal license, since you can choose, which single license
fits to your project and use just that _one_.

== quote from source ==
/*!
* jQuery JavaScript Library v1.7.2
* http://jquery.com/
*
* Copyright 2011, John Resig
* Dual licensed under the MIT or GPL Version 2 licenses.
* http://jquery.org/license
*
* Includes Sizzle.js
* http://sizzlejs.com/
* Copyright 2011, The Dojo Foundation
* Released under the MIT, BSD, and GPL Licenses.
*
* Date: Wed Mar 21 12:46:34 2012 -0700
*/
===

have fun!
mario

[1] http://www.opensource.org/licenses/mit-license.html
[2] http://www.opensource.org/licenses/bsd-license.php/
[3] http://creativecommons.org/licenses/by/3.0/
[4] http://creativecommons.org/choose/
[5] http://www.gnu.org/copyleft/gpl.html
[6] http://en.wikipedia.org/wiki/GPL#Compatibility_and_multi-licensing
[7] http://jquery.com/

[PMario]

On Jul 2, 2:35 pm, mni <sczy...@gmail.com> wrote:
>    - Has the plugin all descriptions necessary for publishing?
I did create a "template" HelloWorld [1] space, that was inspired by
the old tiddlywiki.org plugin best practice HowTo.

The HelloWorldButtonPlugin [1] contains the "whole" plugin header,
which you can copy paste (from the edit view) and just use what you
need. Ther's way to much stuff in it. But imo deleting is easier than
writing :)

A real world header [2] can be seen at SyntaxHighlighterPlugin3
tiddler.

===
One more word about licenses. If you use 3rd party libraries, like I
did with syntax highlighter plugin [2] you should take care, that it
is compatible with the used library [3][4]. Otherwise it may be
difficult to use.

-m

[1] http://helloworld.tiddlyspace.com/#HelloWorldButtonPlugin
[2] http://helloworld.tiddlyspace.com/#SyntaxHighlighterPlugin3
[3] http://syntaxhighlighter.tiddlyspace.com/#ShCore.js
[4] http://helloworld.tiddlyspace.com/#ShBrushPython.js

[Akira D]

Thanks for the info, it was a good question. I never thought of gpl being that much more restrictive.

Sent from Akira's iPad

> --
> You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.

[Akira D]

Personally, I think the more info the better, especially if you want others to build upon it and reduce your inbox with e-mail questions

Sent from Akira's iPad

[mni]

Thanks all for the info, I did not have the time to read all your comments, but my first thought is that the license and header information issue is on a good way. Any ideas on the export and publishing parts?


Cheers,
s.

[chris...@gmail.com]

On Tue, 3 Jul 2012, mni wrote:

> Thanks all for the info, I did not have the time to read all your comments,
> but my first thought is that the license and header information issue is on
> a good way. Any ideas on the export and publishing parts?

This lists some options:

http://tiddlywiki.org/#%5B%5BWhere%20do%20I%20store%20my%20created%20plugin%3F%5D%5D

The basic gist is "get it on the web somewhere" and then "announce
that location in the tiddlywiki group".
--
Chris Dent http://burningchrome.com/
[...]

[PMario]

On 3 Jul., 09:21, mni <sczy...@gmail.com> wrote:
> Thanks all for the info, I did not have the time to read all your comments,
> but my first thought is that the license and header information issue is on
> a good way. Any ideas on the export and publishing parts?

IMO the easiest way is to create TiddlySpace space with your plugin.
GitHub may be an option too, if you use it allready.

-m

[mni]

So thanks again to everyone; After reading all the proposed licenses I've decided to use a CC-BY-NC license, I guess that should do it for now. Inclusion in the core is not an issue since the plugin is quite specialized.

I oriented on the SyntaxHighlighter header (thanks for that one!) as far as I thought it made sense for me, and added more comments in the code and the tiddler itself.

I didn't had tiddlywiki.org on my mind (the site is not that user friendly for noobs so I stopped stumbling upon it quite early), sorry for that (and thanks for not just giving me a RTFM). Anyway, I just tried to create a login at tiddlyspace.com (I decided Github might be a little overdone for just one plugin), but that fails sort of (clicking the "create.." button as well as the "login" button fails... in IE those buttons even show disabled?!) -- am I missing something?

Cheers,
s.

[chris...@gmail.com]

On Wed, 4 Jul 2012, mni wrote:

> I didn't had tiddlywiki.org on my mind (the site is not that user friendly
> for noobs so I stopped stumbling upon it quite early), sorry for that (and
> thanks for not just giving me a RTFM). Anyway, I just tried to create a
> login at tiddlyspace.com (I decided Github might be a little overdone for
> just one plugin), but that fails sort of (clicking the "create.." button as
> well as the "login" button fails... in IE those buttons even show
> disabled?!) -- am I missing something?

Ah, no, I accidently broke it yesterday. Should be fixed now. I
changed how some information that a library needs was to be provided,
and forgot to update the frontpage of tiddlyspace.com accordingly.

If you're still interested you should be able to create an account
now.

[mni]

whohoooo!

All done, thanks. For those who want to take a look (topic is still open for vast destructing criticism ;-): http://northernwinds.tiddlyspace.com/#ChessBoardPlugin

[PMario]

Looks nice
Great work !
-m

[Yakov]

Hi mni,

You may also be interested in indexing your plugin by a couple of
plugin indexes: [1] and [2], although I personally don't know how to
do that.

[1] http://plugins.tiddlywiki.org/plugins/
[2] http://tiddlyvault.tiddlyspot.com/

[mni]

Thanks for the links!

The first one is pretty simple, you just add your name and Plugin URL to a big list and post your Plugin; the second one needs approvement by an administrator - you post your repository URL and suggest it. I just did that, I can keep you updated if you like to know how things go on...

[SpiderX]

Hey, it looks good. I'd want to make the images smaller though, 1k is quite big. You can make the images about 1/4th that size by using a 16 color palette.

[mni]

Yeah, I thought so too, I thing those big image data chunks are really annoying. I just haven't done in the first 'cause I figured out some problems with the alpha channel when using a pallette... I've got this on my agenda (but first I'll streamline the code a little as suggested by Tobi Beer, there's quite some potential in the plugin I'd like to figure out).

Thanks for the tip!


Cheers
s.