Twiki notes for CSCF and MFCF staff

TWIKI Add On Products

• Twiki Add On Products

TWIKI Editors and Plugins

• Gvim integration
• Power Edit Plugin Java 1.1 applet text editor
• Support for the integration of WYSIWYG editors

TWIKI converters

• HTML to TWIKI converter
• Html to TWiki perl parser Part of the future WYSIWYG TWiki editor based on Kupu.
• HTML Tidy Library Project Besides fixing broken html it offers a way to strip out HTML constructs that are not needed. tidy has a huge number of options - that fortunately can be saved in config files. The options are fully documents at http://tidy.sourceforge.net/docs/quickref.html#drop-proprietary-attributes
• Attachment Descussion on twiki.org on conversion of attachments

MSoffice to TWIKI

• Converter for word documents into various formats Converter for word documents into various formats (useful because Word is often used to create HTML - word documents have all sorts of junk in them - this converter will write HTML 4, text and other formats
• http://twiki.org/cgi-bin/view/Codev/MsOfficeIntegration *DOC to TWIKI Example

You will need need wvWiki.xls from  http://twiki.org/~twiki/pub/Codev/MsOfficeIntegration/wvWiki.xsl
$ wvWare -x /usr/share/wv/wvXml.xml foo.doc > foo.xml
$ xsltproc wvWiki.xsl foo.xml > foo.txt

Twiki Web Creation

These notes are for creating a new "Web" in Twiki. There are two basic types in our setup: ones that will use UW authentication (ADFS as of Oct. 2020) and those that will use Twiki authentication. The former is good for webs that are for UW users only. The latter is needed for working with external collaborators. The steps are to first create the Web and then update our Apache configuration to set how it is controlled. Finally, if needed, you will need to define the authorized users.

Create the new Twiki Web

Use the TWiki Web creation form:

• ManagingWebs
  • Naming: Enter a short name of up to 10 characters. The name must start with an upper case letters, followed by optional upper or lower case letters or numbers
  • Based On Web: Pick another Web to use as a style model (Normally use: _default )
  • Web Color: pick one of the StandardColors
  • Description: give a short description
  • Use to: ... finish the sentence
  • Exclude web from "Search all": Yes or No (Hidden or not)

• The TWiki itself lives in the webspace at:
  • linux.cs:/var/www/cs.uwaterloo.ca/twiki/
• Except for some auth configuration in:
  • /etc/apache2/config/sites-available/twiki

If the Web is to be ADFS-authenticated, add to the list under "UWdir-authenticated webs" in Salt:

salt-204:/srv/saltstack/states/cscf_apache/vhosts/sites-config/cs.uwaterloo.ca-twiki.conf

>LocationMatch ^/twiki/(attach|edit|installpasswd|manage|preview|rdiff|rdiffauth|register|rename|save|upload|viewauth)/(Main|TWiki|Sandbox|Trash|AIMAS|CF|CFPrivate|CHIL|CSFaculty|CSEveryBody|CsOps|ISG|MathBusOps|UW|CSGenderEquality|CsAdvisors|AdaptiveAnalysis|CrySP|IE|PLGWiki|WomenInCS|CsGrec|FedFan|FAQA|TestWebS|Faqtest)($|/)<

Registering users

Registering for a UW authenticated Web

Registering for a Twiki authenticated Web

• Use: TWikiRegistrationPub - note; currently broken; use TWikiRegistration
• Create user, eg: Ima User as "ImaUser"

Setting passwords

Password for a UW authenticated Web

• just uses your WatIam password

Password for a Twiki authenticated Web

• uses the htpassword file in:
  • linux.cs:/var/www/cs.uwaterloo.ca/twiki/data
• cd /var/www/cs.uwaterloo.ca/twiki/data
• htpasswd .htpasswd ImaUser

Add users to a group

• Create a new group here: TWikiGroups#Create_a_New_Group specific to the Web and add the list of authorized users