• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7848 for generic doc work for TWiki-6.1.1. Use View topic Item7851 for doc work on extensions that are not part of a release. More... Close
• Anything you create or change in standard webs (Main, TWiki, Sandbox etc) will be automatically reverted on every SVN update.
Does this site look broken?. Use the LitterTray web for test cases.

To enhance the usability of TWiki, the TWiki Tips of the Day (TWiki:TWiki.TWikiTipsOfTheDayAdmin) should be shipped with Dakar.

Discussing with Crawford, I have seen that the goal is to keep the docs as light as possible. While I agree with this goal, I see that it is very essential to get new TWiki users up to speed quickly. Hence, the reason to ship the TWiki Tips of the Day as part of Dakar.

Crawford suggest to create an application that can be installed after the fact. This could be done, but will result in not many sites installing the tips.

A better and more simple way is to add the tips to the official TWiki docs, as has been done on TWiki.org. The tips do not bloat the docs; all topics start with TWikiTip..., and can be removed easily by the few sites admins who do not like them.

In return, the FAQ can be retired and offered only on TWiki.org. They are admin related and do not need to be part of the official docs.

To keep impact minimal for Dakar release I suggest to add the tips and leave the FAQs in Dakar.


CC: yes, i also think that it should be bundled up into a package (this would also mean that it should be easy for people to put "Tips" on their other webs, not just the TWiki web, for their own knowledge domain areas)

PTh: yes, it should ship with dakar (but it can still be made into a separate package and ship with dakar, just as the SpreadSheetPlugin (and many others) are separate packages which ship with Dakar


I think this is some docs worth including to help with Twiki adoption. I'll package it up and include in Dakar. It's one of the small docs tasks I can help with. smile

I see it's easy enough to modify it to create custom tips in other webs.


My point, which I don't think i really got across to Peter (I was too tired last night) is that packaging the tips as a contrib allows for a much simpler update strategy. For example, let's say we have a basic package, TipsContrib, that is bundled with Dakar using a !include in the MANIFEST. Initially it can be pretty sparse. Now, 1 month down the line, there are 1000 new tips. To update their site with the latest tips, the admin only needs to download the latest TWikiTips package and install it, rather than having to patch their whole Dakar installation. Further, by providing the tips in a package we open the door for multiple language translations. Finally, we also simplify the process of automatic updates, something we may consider in future TWiki releases.

Lynnwood, the best model for this package is the JSCalendarContrib. If you provide a perl module (lib/TWiki/Contrib/TipsContrib.pm) that contains the following:

package TWiki:Contrib:TipsContrib;
use vars qw( $VERSION );
$VERSION = '$Rev$';
a build script in lib/TWiki/Contrib/TipsContrib/build.pl as follows
#!/usr/bin/perl -w
  foreach my $pc (split(/:/, $ENV{TWIKI_LIBS})) {
    unshift @INC, $pc;
use TWiki::Contrib::Build;
$build = new TWiki::Contrib::Build("TipsContrib" );
and lib/TWiki/Contrib/TipsContrib/MANIFEST and lib/TWiki/Contrib/TipsContrib/DEPENDENCIES files, then it should all work.


Your point is very well taken, Crawford, since maintaining/updating docs is a major problem with prior versions of TWiki. I'll try following the method you generously outlined above. Thanks!


Committed revision 6925

Uploaded TipsContrib. Not tested yet. Still need to attribute to TWikiContributor.


All done. Committed revision 6960.


Lynnwood, please comment on Item669


TipsContrib needs TWiki:Plugins.TipsContrib documentation. click here to create the documentation: http://twiki.org/cgi-bin/edit/Plugins/?topic=TipsContrib&templatetopic=NewContribTemplate&topicparent=ContribPackage&onlywikiname=on&onlynewtopic=on&TopicClassification=ContribPackage

also, TipsContrib.txt needs to be added as data/TWiki/TipsContrib/TipsContrib.txt to SVN and its MANIFEST file.


Summary TWiki Tips missing
ReportedBy TWiki:Main.PeterThoeny
AppliesTo Documentation
Priority Urgent
CurrentState Closed

Checkins 6925 6936 6960 6961 6962 6964 6965 6971 6981
Edit | Attach | Watch | Print version | History: r11 < r10 < r9 < r8 < r7 | Backlinks | Raw View |  Raw edit | More topic actions
Topic revision: r11 - 2005-10-11 - WillNorris
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback