TWiki/TWikiTopics.mdwn

   1 # <a name="TWiki Topics"></a> TWiki Topics
   2
   3 <div>
   4   <ul>
   5     <li><a href="#TWiki Topics"> TWiki Topics</a><ul>
   6         <li><a href="#Topic Features"> Topic Features</a></li>
   7         <li><a href="#How to create and edit a topic"> How to create and edit a topic </a></li>
   8         <li><a href="#How to attach files and use othe"> How to attach files and use other features</a></li>
   9         <li><a href="#How to rename, move or delete a"> How to rename, move or delete a topic</a></li>
  10       </ul>
  11     </li>
  12   </ul>
  13 </div>
  14
  15 The basic building block of a TWiki site is called a **_topic_**, identified by a unique, hopefully descriptive, [[WikiWord]] title. It may seem easier just to call them pages - but when you've used TWiki for a while, the difference is obvious. In the end,
  16
  17 ## <a name="Topic Features"></a> Topic Features
  18
  19 A TWiki topic is a self-contained information unit rich in features. Each topic has:
  20
  21 - a [[WikiWord]] title that lets you:
  22   - instantly identify what the topic is about
  23   - link to it from other topics just by typing it in
  24 - an [[edit link|Main/WebHome#PageBottom]] to a collaboration area where you can:
  25   - enter plain text, leaving a blank space between paragraphs like email (all you need)
  26   - use simple TWiki shorthand to represent complex HTML and special TWiki tags
  27   - include links to other topics, Web sites, images, sound files, or anything else you can put on a regular Web page, using easy shorthand
  28   - do all of that within your browswer, with no HTML editor, just simple codes and a handy pop-up quick reference panel
  29 - extra [[Web forms|TWiki/TWikiForms]] option:
  30   - store database-style info alongside the free-form topic content
  31   - use text fields and boxes, radio buttons, pulldown selector menus, checkboxes
  32   - create your own forms to tag topics to later search, sort and display
  33 - a [[FileAttachment]] feature that lets you:
  34   - upload files through your browser to the TWiki server
  35   - attach any type of file (documents, images, applications) for viewing online, storage or sharing downloads with others
  36   - upload revisions of existing files with automatic backup of all previous versions
  37 - [[TWiki Skins|TWiki/TWikiSkins]] to customize the look of headers and footers when topics are converted to Web pages for display:
  38   - apply skins across an entire TWiki web, or to a single displayed page
  39   - use included skins and easily create new ones
  40   - try the <code>**[Printable]**</code> skin below: stripped down headers and footers suitable for clean hard copy
  41 - browser-based controls for [[renaming, moving, and deleting|Main/WebHome#RenamingTopics]] topics:
  42   - rename a topic and automatically update all of the links to it, site-wide
  43   - move a topic from one TWiki web to another
  44   - safely delete a topic to a special Trash web (invisible, but recoverable from the Web server if necessary)
  45 - flexible [[access control|TWiki/TWikiAccessControl]]:
  46   - independently determine who can see, edit, rename, move or delete topics
  47   - set permissions by individual users and user groups
  48 - RCS revision control to automatically save all topic changes:
  49   - efficiently stores every change made to the original version
  50   - lets you compare and retrieve changes between any two versions, or review them all
  51   - displays any previous version as a regular Web page or as raw topic text
  52 - a referred-by search that list all topics that link to a particular topic
  53 - hierarchical parent-child topic navigation:
  54   - automatically links a new topic as the "child" of the topic it was created from
  55   - allows manual assignment of parent topic from a list of all topics in the local web
  56   - offers navigation displays, by topic parent, or by related topic
  57 - many more features...
  58
  59 The configuration of your TWiki site and your personal user account determine which of these features are installed and available to you.
  60
  61 <a name="EditingPages"></a>
  62
  63 ## <a name="How to create and edit a topic"></a> How to create and edit a topic
  64
  65 Making it incredibly easy for you to add and edit information on existing topics, create new topics, and link all TWiki topics, is a TWiki main function.
  66
  67 - **To modify a topic**, click the <code>**Edit**</code> link at the left of the toolbar at the bottom of every page. An editing window appears. Type away. Use the [[GoodStyle]] and [[TextFormattingRules]] links to get pop-up window help.
  68   - Click <code>**Preview Changes**</code> to see how your edit looks.
  69   - Click <code>**Save Changes**</code> to save.
  70
  71 - **To add a new topic**, the simplest way is to type a new [[WikiName]] on an existing topic, while you're in edit mode. When the topic is saved, the new name will appear highlighted, with a **?** at the end: click the **?** and a new edit window appears. Enter, preview and save as usual. The new topic now exists.
  72   - Go back to the topic where you started, and you'll see the **?** has disappeared, and your [[WikiWord]] name is now a regular link. Type it anywhere on any topic in that web, and it will be turned into a link.
  73   - %H% **One little links rule: each topic, and its [[WikiWord]] link, belong to one unique web only.** To link _between_ webs, you must first enter the topic's web name. <br />**_Example:_** This is [[TWikiTopic]], in the <code>**TWiki**</code> web, so that's all you need to type on any topic in this web. But to link to [[TWikiTopics]] from a topic in the <code>**Main**</code> web, you have to type <code>**TWiki.TWikiTopics**</code> - <code>**Webname.TopicName**</code>. It's easy.
  74
  75 <a name="OtherFeatures"></a>
  76
  77 ## <a name="How to attach files and use othe"></a> How to attach files and use other features
  78
  79 The color-coded toolbar at the bottom of every topic displays a series of links, including:
  80
  81 - <code>**[Attach]**</code> - pops a new screen for [[FileAttachments]]
  82 - <code>**[Ref-By]**</code> - displays all the TWiki topics with links to the topic you're on
  83 - <code>**[Diffs]**</code> - generates a page showing every change made to the topic you're on, with names, dates, and changes made
  84 - <code>**r1.3 | &gt; | r1.2**</code> _(ex)_ - some specific previous version stuff that you can check out on your own
  85 - <code>**[More]**</code> - opens up a whole new screen of additional controls
  86
  87 It looks like a lot - it is a lot, and there's more. BUT, it's all simple, flexible, and optional - the only way to confuse yourself or your site set-up and users is by using features you really don't need. Unlike the usual expensive, complex collaboration and project management packages, TWiki is fully functional and effective just by typing in text and making [[WikiWord]] links. All the rest is there only if you need it!
  88
  89 - Most controls are **self-explanatory**, and also include instructions and help links.
  90 - **Experiment**. You can always <code>**Cancel**</code> or go Back whenever you like.
  91 - Get **in-depth info** from the [[complete documentation|TWiki/WebHome]], including the User's Guide and Configuration Manual and TWiki Reference.
  92
  93 <a name="RenamingTopics"></a>
  94
  95 ## <a name="How to rename, move or delete a"></a><a name="How to rename, move or delete a "></a> How to rename, move or delete a topic
  96
  97 You can now rename, move and delete individual topics from your browser. All three options are available by clicking <code>**More**</code> on the control strip at the bottom of every page. The access settings for a topic, web or entire site may be disabled for one or more of the three options, depending on your site set-up and personal permissions. In any case, all three are similar and extremely easy to use.
  98
  99 1. Go to the top you want to change, click <code>**More &gt; Rename/move**</code>
 100 2. **To move or delete:** select the target web (<code>**Trash**</code> to delete)from the pull-down menu (otherwise, leave on the current web)
 101 3. **To rename:** fill in a new [[WikiName]] (otherwise, leave the current topic name)
 102 4. **To update links:** From the list of topics that show links to the topic you're changing, uncheck each entry you DON'T want to update - only checked links will be updated;
 103 5. Click <code>**Rename/move**</code>: the topic is renamed and/or moved, and the checked links to the topic are updated.
 104   - Any problems are listed - take note, and you can fix them later.
 105   - If a linked topic can't be updated (it may be locked because someone's editing it), an alert will appear. You can update missed topics later by again pressing <code>**Rename/move**</code>.
 106
 107 %H% Deleting means moving a topic to the Trash web. Since all webs share the one Trash, name conflicts may come up.
 108
 109 See: [[ManagingTopics|Main/TWikiDocumentation#Managing_Topics]] for more details.
 110
 111 -- [[MikeMannix]] - 12 May 2002