documentation7Remove my vote on this tag tables1Add my vote for this tag create new tag
, view all tags
Get Involved!
TWiki is an open source project with 10+ years of history, built by a team of volunteers from around the world, and used by millions of people in over 100 countries. The community is focusing on building the best collaboration platform for the workplace. We invite you to get involved!

ALERT! NOTE: This is a DistributionDocument. Please help maintain high quality documentation: This is a wiki, please fix the documentation if you find errors or incomplete content. Put questions and suggestions concerning the documentation of this topic in the comments section below. Use the Support web for problems you are having using TWiki.

20-Minute TWiki Tutorial

This step-by-step, hands-on tutorial gets you up to speed with all the TWikiSite basics, in mere minutes...

1. Get set...

Open two browser windows, so that you can follow these steps in one window, while trying things out in the other.

2. Take a quick tour...

A TWikiSite is divided into webs; each one usually represents one workspace for collaboration. You can navigate the webs from the Home menu of each web page.

  • Each web has hyperlinked topics, displayed as pages in your browser.
  • The home page in each web is the WebHome topic.
  • To browse a TWiki web, just click on any highlighted link. These links are called WikiWords and comprise two or more words with initial capitals, run together.
  • Follow the WikiWord link and learn what it is.
  • If you know the name of a topic, you can jump directly to it by typing its name into the JumpBox on the top of the page. Type WebNotify to jump to the WebNotify topic. Hint: Do not confuse the Jump box with search.
  • You can search each TWiki web. Enter a search string in the WebHome topic or the WebSearch topic accessible from the Search link in the Web menu. TWiki searches for an exact match; optionally, you can also use RegularExpressions.

3. Create an account...

To edit topics or participate in restricted webs, you need to have a TWiki account.

  • Go to the TWikiRegistration page to create your TWiki account. Fill in a couple of lines and you're set!

4. Check out TWiki users & groups...

  • Go to the UserList topic; it has a list of all users of TWiki. Your name will be in this list after you register.
  • Go to the TWikiGroups topic in the Main web; it has a list of groups which can be used to define fine grained TWikiAccessControl in TWiki.

5. Learn the page controls...

The buttons at the top and the color-coded control strip at the bottom of the page have a collection of action links. Different skins show different links, but most will have some or all of:

  • Edit - add to or edit the topic (discussed later)
  • Raw Edit - edit the topic using WikiSyntax (discussed later)
  • Raw View - show the source text without editing the topic
  • Attach - attach files to a topic (discussed later)
  • Backlinks - find out what other topics link to this topic (reverse link)
  • Print version - goes to a stripped down version of the page, good for printing
  • History - topics are under revision control - History shows you the complete change history of the topic, for example, who changed what and when
  • r3 > r2 > r1 - view a previous version of the topic or the difference between two versions
  • More topic actions - additional controls, such as rename/move, version control, and setting the topic's parent.

6. Create a topic, modify a topic, and link to a topic...

Go to the Sandbox. This is the sandbox web, where you can create topics and add content to try it all out at will.

  • To create your own test topic, click on Create TestTopic###, or invent a WikiWord and click on Create by Name. You are now in edit mode where you can add content to the new topic. Save the topic and voilą, you just created your first TWiki page!
  • Click on Edit to modify your own test topic again (or any other topic for that matter).
  • Now, let's create a new topic starting from your own test topic:
    1. In edit mode, enter a new text with a WikiWord, for example:
      This is TWikiGuestSandbox topic.
    2. Save the topic. The name appears highlighted with a red-link. This means that the topic doesn't exist yet.
    3. Click on the red-link. Now you're in edit mode for the new topic.
    4. Type some text. You can add headings, bullets, tables, and more using the controls of the WYSIWYG editor.
    5. A signature with your name is already entered by default. Keep it at the bottom.
      Note: The Main. in front of your name is a web prefix. It means that you have a link from the current web to your personal topic located in the Main web.
    6. Save the topic...
  • Link to another topic:
    1. In edit mode, enter the WikiWord of a topic that already exists in the Sandbox web, for example:
      This links to WebSearch.
    2. Save the topic. WebSearch is now a link you can click.
      Note: WikiWords are linked automatically; there is no link if you look at the text in edit mode.
    3. You can also create a nice looking link without a BumpyWord. Enter for example:
      [[WebSearch][This is a link to search]].
  • Learn about Raw Edit (for advanced/technical users)
    1. Topics can be modified in WYSIWYG mode (default) and in Raw Edit mode. Raw mode shows text in TWikiShorthand, a very simple markup language. Follow the TWikiShorthand link to see how, then:
    2. Go back to your own sandbox topic and Raw Edit it.
    3. Enter some text in TWikiShorthand: bold text, italic text, bold italic text, a bullet list, tables, paragraphs, etc.
      Hint: If you need help, click on the Edit help link located above the text edit box.
    4. Save the topic.
  • TIP Tip: When you only want to see the source code of a topic click the Raw View link.

7. Use your browser to upload files as page attachments...

You can attach any type of file to a topic - documents, images, programs, whatever - where they can be opened, viewed, or downloaded.

  • Attaching files is just like including a file with an e-mail.
    1. Go back to your sandbox topic and click on Attach.
    2. Click [Browse] to find a file on your machine that you'd like to attach; enter an optional comment; leave everything else unchecked.
    3. Click [Upload file], then scroll to the end of the page to see the new attachment listing.
  • Do this again - this time, upload a .gif, .png, or .jpg image file.
    • Check the Link box to create a link to the attached file at the end of the topic. The image will show up at the bottom of the topic.
    • Edit the topic to move/resize the image.
  • If you have an image of yourself, your cat, your sprawling family estate...why not upload it now to personalize your TWiki profile page TWikiGuest?

8. Get alerted whenever topics are changed...

WebNotify is a subscription service that automatically notifies you by e-mail when topics change in a TWiki web. This is a convenience service - for many people, checking e-mail is easier than checking the Web.

  • If you're using TWiki to collaborate on a project, it's important to know when anyone on your team posts an update. If you're following a specific discussion, it's convenient to know when there's new input.
  • Alerts are e-mailed as links to individual topics that have been changed in a set period: Each day, every hour, whatever is configured for your system.
  • It's strongly recommended that you try out the service by subscribing to each TWiki web that's relevant to you. You can subscribe and unsubscribe instantly, on a per web basis using WebNotify.
  • If you prefer, you can subscribe to RSS and ATOM feeds. Every web has a WebRss feed and a WebAtom feed, respectively.
That's it! You're now equipped with all the TWiki essentials. You are ready to roll.

TIP Note: When first using TWiki, it will probably seem strange to be able to change other people's postings - we're used to separating individual messages, with e-mail, message boards, non-wiki collaboration platforms. Don't worry about it. You can't accidentally delete important stuff - you can always check previous versions, and copy-and-paste from them if you want to undo any changes. After a short while, TWiki-style free-form communication becomes second-nature. You'll expect it everywhere!

Related Topics: UserDocumentationCategory, WelcomeGuest, ATasteOfTWiki, TWikiVariables, WikiSyntax, TWikiDocGraphics

-- Contributors: TWiki:Main/ArthurClemens, TWiki:Main/AurelioAHeckert, TWiki:Main/ChrisGarrod, TWiki:Main/MikeMannix, TWiki:Main/SebastianKlus, TWiki:Main/PeterThoeny

Comments & Questions about this Distribution Document Topic

The TWikiUsers topic in the TWiki.Main web looks very empty to me, even after I have registered myself...

Actually, I was first looking for instructions pertaining to the local installation of the beta TWiki to my own machine, instructed by the readme file to look for a TWikiDocumentation and wanting to compare the version I had locally with the last one from the org site

-- MarcGirod - 02 Apr 2005

The TWikiUsers topic is now fixed.

-- PeterThoeny - 04 Apr 2005

Still seems like it doesn't hold your hand enough for non-HTML/programmer types, the users I'm looking at would need a WYSIWYG 'Word'-ish interface.

Still, better than Drupal, and it's Perl CGI (not mod_perl like Slash!)

-- SimonJohn - 17 Aug 2005

TWiki 4.2 has a relatively solid WYSIWYG editor.

-- PeterThoeny - 04 Jul 2008

Point (2) talks about the Webs being in the "top right" part of the page, but that is not where they are located in the default skin. Perhaps this should be made location neutral, like "toward the top of each page" or maybe just give examples of how it looks in Pattern skin.

Also, I think now that the WYSIWYG editor comes standard in TWiki 4.2, this document needs a pretty substantial overhaul. If I send a link to this tutorial on our wiki to some of our less technical coworkers, they are going to get confused when it starts talking about editing pages, and what toolbar buttons / commands are present on every page for toolbar. Either that, or revert to having an "Edit" button and a "WYSIWYG" button. That might confuse new, non-technical users as well, but seems to be the outcry around TWiki:TWiki smile

-- AdamNofsinger - 08 Jul 2008

Good points, thanks Adam. Please feel free to help improve the documentation. Edit this page here.

-- PeterThoeny - 13 Jul 2008

I just updated this topic so that it fits more to the current TWiki stable. Any comments are welcome!

-- SebastianKlus - 30 Jul 2008

soy nuevo en esto

-- JairPaquini - 2010-09-11

Tried to insert a table. Clicked on the "inserts a table" icon. A "insert/modify table" window appears. I enter the row and column count and click on insert. Nothing is inserted but the column and row count in the "insert/modify" window change back to their default (2) values.

-- MarcRemijn - 2010-11-05

The table problem seems to be a problem when using "Safari", using "Firefox" it works OK.

-- MarcRemijn - 2010-11-05

Ah, could you file a bug with details? TWikibug:WebHome.

-- PeterThoeny - 2010-11-05

How do I allow larger attachments? The limit of 50 kb is very limiting.

-- TomNolan - 2011-01-21

That is the limit on twiki.org, see WhatTWikiDotOrgIsNot. If you let us host TWiki for you or if you download and install TWiki you can set your own limit.

-- PeterThoeny - 2011-01-21

Thanks MikeBomkamp for the type fix. I updated the source in SVN repository accordingly.

-- PeterThoeny - 2011-03-02

Hi StephanHennig, thanks for updating the docs with optional WebHome name. I decided to document that in the reference manual at ManagingWebs#NamespaceAndURL instead of the tutorial, because the tutorial should be as short as possible and contain only content needed to get started.

-- PeterThoeny - 2011-09-24

Does anyone know why with some TWiki pages when you hit edit the cursor goes to the bottom of the page in the edit window? And for others, when you hit edit, the cursor stays at the top?

-- AddyYeow - 2012-02-02

I recall that this is a bug with a certain version of IE. Please ask support questions in the Support web, thank you.

-- PeterThoeny - 2012-02-02

Please use the Support forum if you have questions about TWiki features. This comment section is about the documentation of this topic.
Edit | Attach | Watch | Print version | History: r124 < r123 < r122 < r121 < r120 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r124 - 2012-08-24 - PeterThoeny
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.