Install from GitHub - how?

[Mat]

I wish to try out Felix's TopStoryView (a result from this multi-facetted discussion) i.e a story view that focuses on putting tiddlers at top of storyview... but how do I proceed from GitHub? What do I need there and how do I actually install it into my TW?

Thank you!

<:-)

[Astrid Elocson]

Hi Mat,

I think the easiest way to do this is to use Node.js. (If there's an easier way, I'm sure someone else will soon let us know :)

Download a copy of Jeremy's repository by clicking "Download ZIP" at https://github.com/Jermolene/TiddlyWiki5/tree/master and unzip it.

Then do the same for Felix's repository. His zip file contains a dist folder with a felixhayashi subfolder. Copy the felixhayashi folder so that it becomes a subfolder of the TiddlyWiki5/plugins folder in your unzipped copy of Jeremy's repository, i.e. so that it sits alongside the existing tiddlywiki folder there.

Then go to one of the subfolders of editions, e.g. empty or (to get some content to play with) tw5.com. In there you'll find a text file called tiddlywiki.info, which contains (among other things) a list of plugins. Add Felix's plugin to the end of the list, with a comma separating it from the previous item, like this:

    "plugins": [
        "tiddlywiki/googleanalytics",
 ...
        "tiddlywiki/railroad",
        "felixhayashi/topstoryview"
    ],

Now all you need do is:

• go to a terminal window or command prompt,
• change directory to the TiddlyWiki5 folder of your copy of Jeremy's repository (where a file called tiddlywiki.js resides),
• run node tiddlywiki.js editions/empty --server (changing empty to whichever edition you chose to add the plugin to),
• and in your browser go to http://127.0.01:8080/ (or whatever address Node.js tells you it's serving the wiki on).

Good luck!

– æ

[Felix Küppers]

Hi Mat!

Astrid already exhaustively described how to install it using github and node.js (thanks @astrid).

Another way of course is to go to the TiddlyMap demo site's config and drag'n'drop the plugin from there.

-Felix

[Astrid Elocson]

Hi Felix,

A drag and drop from the demo site would certainly be much easier. I should have read to the end of your GitHub readme :)

At least the Node.js info I've given may help someone else with a similar question some day.

– æ

[Tobias Beer]

Another way of course is to go to the TiddlyMap demo site's config and drag'n'drop the plugin from there.

That's what I did.

One tiddler.

Done.

Best wishes, Tobias. 

[Felix Küppers]

Hi Astrid

A drag and drop from the demo site would certainly be much easier. I should have read to the end of your GitHub readme :)

Speaking of it, I think I forgot to add installation instructions :)
 

At least the Node.js info I've given may help someone else with a similar question some day.

I am sure of that. It's a neat explanation and actually should be documented somewhere officially. I also think it would be nice if other plugin developers follow the standard of creating a dist folder for their plugin to facilitate the integration as you describe it above.

-Felix

[Mat]

Thank you all for your replies, particularly Astrid for the details which I guess is what you have to do in the case when there is no TW to drag a link from. Now I know!

 <:-)