Getting started contributing

263 views
Skip to first unread message

Tony Grosinger

unread,
Oct 1, 2015, 5:15:35 PM10/1/15
to TiddlyWikiDev
I am very interested in getting started contributing to TiddlyWiki. I think it's a great project and want to help out where I can. Often open source projects will have a label in their issue tracker that calls out "easy" tickets to help new contributors get going. 

Is there anything like that with TW? Anyone have any recommendations that really helped them when they first started?
I have written a small plugin and have a small sense of how TW works, but there's a ton to learn.

Thanks.

Tobias Beer

unread,
Oct 1, 2015, 5:26:06 PM10/1/15
to tiddly...@googlegroups.com
Hi Tony,
 
I am very interested in getting started contributing to TiddlyWiki.

Great, and welcome! :-)
 
I think it's a great project and want to help out where I can. 
Often open source projects will have a label in their issue tracker 
that calls out "easy" tickets to help new contributors get going. 

Don't think there is such a label yet, but it might be worth having. (@Jeremy)
One way to approach this is going through the issues one by one
and evaluating which one you might have an idea as to how to resolve... or want to ask.

Anyone have any recommendations that really helped them when they first started?

Many contributors start with some version of a "this is how you do this and that" wiki.
 
I have written a small plugin and have a small sense of how TW works, but there's a ton to learn.

There is indeed... and figuring out where to start can be a bit of a steep learning curve.
What plugin? ;-)

I follow the groups and the github repo and that gives more than plenty food for thoughts.
Trying to find answers to the questions that pop up
often has me discover things I didn't consider before.

Other than that, if you want to activate descovery mode...
Best wishes,

— tb

Tony Grosinger

unread,
Oct 1, 2015, 7:47:33 PM10/1/15
to tiddly...@googlegroups.com
What plugin? ;-)
 
http://grosinger.net/tw5-checklist/

I think it would be made obsolete by this issue though: https://github.com/Jermolene/TiddlyWiki5/issues/1957

Tobias Beer

unread,
Oct 1, 2015, 9:10:20 PM10/1/15
to tiddly...@googlegroups.com
I think it would be made obsolete by this issue though: https://github.com/Jermolene/TiddlyWiki5/issues/1957

Yes, but you would possibly need two fields:
  1. a list-field for all todo items as a "bracketed list" of tiddler titles on the check-list, sorted
  2. a list field for the checked state with a "bracketed list" of all items that are checked
Best wishes,

— tb

Jeremy Ruston

unread,
Oct 4, 2015, 12:20:27 PM10/4/15
to tiddly...@googlegroups.com
Hi Tony

I am very interested in getting started contributing to TiddlyWiki. I think it's a great project and want to help out where I can.

Great stuff, thanks for the enthusiasm!

Often open source projects will have a label in their issue tracker that calls out "easy" tickets to help new contributors get going. 

No, but it’s a good idea, and I’d be happy to introduce one. You’ll be able to spot some easy ones, but don’t be afraid to ask questions on any ticket where there isn’t enough information to understand the complexity of the fix.

Best wishes

Jeremy


Is there anything like that with TW? Anyone have any recommendations that really helped them when they first started?
I have written a small plugin and have a small sense of how TW works, but there's a ton to learn.

Thanks.

--
You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywikide...@googlegroups.com.
To post to this group, send email to tiddly...@googlegroups.com.
Visit this group at http://groups.google.com/group/tiddlywikidev.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywikidev/3eb59e00-0981-4997-9133-45916c9dd746%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Jed Carty

unread,
Oct 7, 2015, 9:33:34 AM10/7/15
to TiddlyWikiDev
That is a very clean interface and it seems to work very smoothly.

I have one suggestion for remaining consistent with how everything else in tiddlywiki works. While putting the entire state for checked and unchecked into a single tiddler is a good idea, currently tiddlywiki can't handle json data with more than one level. To get around this, instead of making a checked group and an unchecked group, I would name every item in the list in the tiddler that stores the state and give each one a value checked or unchecked. This would let people get the data about which item is checked or unchecked using filters or other things in the wiki.
When we add better support for arbitrary json data that wouldn't be a problem, but for now this would allow you to do things like have multiple lists and automatically generate a list of all checked or unchecked items from a set of lists using only wikitext.

Unless you have some objection I am going to put this in the plugin listing here so it shows up in the community search.

Tony Grosinger

unread,
Oct 7, 2015, 10:33:53 AM10/7/15
to tiddly...@googlegroups.com
To get around this, instead of making a checked group and an unchecked group, I would name every item in the list in the tiddler that stores the state and give each one a value checked or unchecked. 

It's very funny you should mention this. I actually spent last night re-writing the plugin from scratch moving it away from the behavior you specify. Take a look at the gh-pages branch from a day or so ago to see what I mean. I made this change because it greatly simplifies future behavior I would like to add, such as hiding checked items and moving checked items to the bottom of the list.

Maybe we could look into expanding the functionality of wiki.getTiddlerData and wiki.setText rather than restricting the types of documents we can use as data tiddlers.


Unless you have some objection I am going to put this in the plugin listing here so it shows up in the community search.

Not at all, please do! 

Jed Carty

unread,
Oct 7, 2015, 6:13:44 PM10/7/15
to TiddlyWikiDev
The plugin is listed on my site, if things all work it should be listed on the community search within a day or so.

Pit.W.

unread,
Mar 14, 2016, 2:59:06 PM3/14/16
to tiddly...@googlegroups.com
1.) From Newbie to Newbie:

This easy to handle plugin also allows checklists in multiple columns. But not by using the TW- typical pipe (|) to define the table, but by using html table formatting:

<table>
<tr><td>
[ ] check1
</td>
<td>
[ ] [[check2]]
</td>
</tr>
</table>

The cruicial thing is to have the checkbox [ ] at the beginning of the line. So, this does NOT work:
<td>[ ] check </td>

2.) Tony , Thank You for this helpful tool. I cant see why it should become obsolete, it is so pleasant to use.

Usecase
Very helpful for a small general-purpose TW, to be carried as a template on the smartphone like: "oh, I just learned that my plane is  4 hours late. Internet is not avilable. I might use the time in the airport. Let me have a coffee and make a plan:"

! buy christmas gifts
[ ] RC helicopter
[ ] Perfume
[ ] Diamond Ring

!Other
[ ] Get haircut
[ ] buy a tie
[ ] call [[Hotel]]
[ ] report lost baggage, get [[lost baggage hotline number]]

!Work
[ ] write mails to [[assistant]], to be delivered later
[ ] call [[my deputy]]
[ ] check: can meeting at 19:00 be postponed?
[ ] New appointment possible at 23:00?
[ ] check with the chairman of the board

!Contingency
[ ] What if client is not available at that time : make [[Plan B]]
[ ] make [[Plan C]] if chairman decides negatively

Such a template is lightweight, comparatively fast, runs on a weak phone,... sort of a last-resort-Plan-B/Plan-C-resource;

Back home, the tiddler goes into my huge main TW, which runs under Node, ... all without cloud, hostile Apps, ...

Thanks again,

Pit.W

Am 29.02.2016 um 21:05 schrieb Alain Dutech:
--
You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywikide...@googlegroups.com.
To post to this group, send email to tiddly...@googlegroups.com.
Visit this group at http://groups.google.com/group/tiddlywikidev.

Knut Franke

unread,
Mar 15, 2016, 4:14:25 PM3/15/16
to TiddlyWikiDev
On Friday, October 2, 2015 at 1:47:33 AM UTC+2, Tony Grosinger wrote:

Neat! I've started testing how this works for my personal todo list. Pro: very easy to set up, and hyperlink to other content (in the wiki and elsewhere). Main downside: no easy way of tagging/categorizing/prioritizing items (and filtering accordingly).

I think it would be made obsolete by this issue though: https://github.com/Jermolene/TiddlyWiki5/issues/1957

I don't think so.

Pit.W.

unread,
Jul 1, 2018, 11:53:51 AM7/1/18
to tiddly...@googlegroups.com

The better the cook, the hungrier the guests

Tony,

I use your checklist plugin in app. 20 to 40 wikis(single file) and 3 gigantic wikis on node.js. It is a great tool, please accept my gratitude.

There is feature which would substantially add value - at least for me, but possibly also for others:
If I enter a new item into the checklist - woulld it be possible that it automatically turns into a link (meaning adding double square brackets)? Ideally this feature could be turned on and off in the configuration.
If this request disrupts your other activities, please ignore and accept my apologies.

Kind regards

Pit.W
On Thursday, October 1, 2015 at 2:26:06 PM UTC-7, Tobias Beer wrote:
--
You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywikide...@googlegroups.com.
To post to this group, send email to tiddly...@googlegroups.com.
Visit this group at http://groups.google.com/group/tiddlywikidev.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywikidev/5b21c652-9243-49f5-b242-7c24cc2d839d%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.



_________________________________________________________________
________________________________________________________
Ihre E-Mail-Postfächer sicher & zentral an einem Ort. Jetzt wechseln und alte E-Mail-Adresse mitnehmen! https://www.eclipso.de


Mohammad Rahmani

unread,
Jul 1, 2018, 1:43:10 PM7/1/18
to TiddlyWikiDev
Tony!
Don't you want to update and maintain the plugin? This is wonderful.

/Mohammad

Tony Grosinger

unread,
Jul 2, 2018, 10:16:27 AM7/2/18
to TiddlyWikiDev
Pit.W,
Thank you for the kind words!
Your feature request is certainly possible. I have entered it in the issue tracker so it is not missed in the future. You can find that here: https://github.com/tgrosinger/tw5-checklist/issues/46

I am moving this summer, so my time dedicated to TiddlyWiki dev will be very limited, but I will work on this issue next time I have a chance.
Reply all
Reply to author
Forward
0 new messages