none
[openafs-wiki.git] / TWiki / TWikiTopics.mdwn
index 99fccb6..5298fa7 100644 (file)
-# <a name="TWiki Pages"></a> TWiki Pages
+# <a name="TWiki Topics"></a><a name=" TWiki Topics"></a> TWiki Topics
 
 <div>
   <ul>
-    <li><a href="#TWiki Pages"> TWiki Pages</a><ul>
-        <li><a href="#Page Features"> Page Features</a></li>
-        <li><a href="#How to create and edit a page"> How to create and edit a page</a></li>
-        <li><a href="#How to attach files and use othe"> How to attach files and use other features</a></li>
-        <li><a href="#How to rename, move or delete a"> How to rename, move or delete a page</a></li>
-      </ul>
-    </li>
+    <li><a href="#Characteristics"> Characteristics</a></li>
+    <li><a href="#Creating and editing topics"> Creating and editing topics</a></li>
+    <li><a href="#Other features"> Other features</a></li>
+    <li><a href="#Renaming, moving or deleting top"> Renaming, moving or deleting topics</a></li>
+    <li><a href="#Reviewing and Reverting"> Reviewing and Reverting</a></li>
   </ul>
 </div>
 
-Each page in a TWiki web is called a **_topic_**, defined by its meaningful, descriptive [[WikiWord]] title.
+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 specifically a topic is the content of a page. The distinction seems small but will become more important as your skill using TWiki increases. [[TWikiSites]] are built using topics.
 
-## <a name="Page Features"></a> Page Features
+## <a name="Characteristics"></a> Characteristics
 
-A TWiki topic is a self-contained information unit rich in features:
+A TWiki topic is a rich information unit. **Each** topic has:
 
-- a [[WikiWord]] title that lets you:
-  - instantly identify what the page is about
-  - automatically link to it from other pages
-- an edit-anywhere collaboration area where you can:
-  - enter plain or fully-HTML formatted text
-  - work with simple TWiki editing shorthand (that includes HTML mark-up and special TWiki functions)
-  - include Web links, images, anything else you can put on a Web page
-- an extra [[forms input|TWiki/TWikiForms]] option:
-  - store structured info alongside the free-form page content
-  - use text fields and boxes, radio buttons, pulldown selector menus, checkboxes
-  - select from one or many different input forms, with all data preserved
-- a [[FileAttachment]] feature that lets you:
-  - upload files through your browser to the TWiki server
-  - attach any type of file (documents, images, applications) for viewing or downloading
-  - make changes and update existing files
-- [[TWiki Skins|TWiki/TWikiSkins]] to customize the look of headers and footers:
-  - apply skins across an entire TWiki web level, or to a single page
-- browser-based controls for [[renaming, moving, and deleting|Main/WebHome#RenamingTopics]] pages:
-  - rename a page and automatically update all the references to it, site-wide
-  - move a page from one TWiki web to another
-  - safely delete a topic to a special Trash web (invisible, but accessible to the TWiki administrators if needed)
-- flexible [[access control|TWiki/TWikiAccessControl]]:
+- name
+  - instantly identify what the topic is about
+  - link to it from other topics just by typing it in it's [[WikiWord]]
+- content
+  - edited by simply clicking the [[edit link|Main/WebHome#PageBottom]]
+  - enter plain text, leaving a blank space between paragraphs like email (all you need)
+  - enter simple TWiki shorthand to represent complex HTML and special TWiki tags
+  - enter HTML if you are familiar with it
+  - include links to other topics, URLs, Web sites, files, images, sounds, or anything else you can put on a regular Web page
+  - handy pop-up quick reference
+  - do all of this through whatever web browser you are familiar with
+- [[access control|TWiki/TWikiAccessControl]]
   - independently determine who can see, edit, rename, move or delete topics
   - set permissions by individual users and user groups
-- revision control automatically saves topic changes:
-  - uses the established standard RCS (Revision Control System)
+  - over-ride topic, TWiki web or site
+- revision control
+  - topic changes are automatically saved
   - efficiently stores every change made to the original version
-  - allows comparison of changes between any two versions, and review of any version, as formatted or raw text
-- referred-by searches that list all topics in a web or site wide that link to a particular page
-- hierarchical parent-child topic navigation:
-  - automatically links a new page as the "child" of the page it was created from
-  - allows manual assignment of parent page from a list of all topics in the local web
-  - offers navigation displays, by topic parent, or by related topic
+  - lets you compare and retrieve changes between any two versions, or review them all
+  - displays any previous version as a regular Web page or as raw topic text
+- TWiki web
+  - a TWiki organizational unit to which the topic belongs
+  - relevant when searching for a topic, referencing it or typing in it's URL
+- meta-data
+  - hidden contextual data stored within each topic.
+  - parents
+    - automatically links a new topic as the "child" of the topic it was created from
+    - hierarchical, parent-child navigation
+    - allows manual assignment of parent topic from a list of all topics in the local web
+    - offers navigation by topic parents
+- backlinks
+  - named referred-by (Ref-By)
+  - lists all topics that reference the current topic
+
+Features that can be used by topics and sites include:
+
+- [[TWiki Skins|TWiki/TWikiSkins]] to customize the look of headers and footers when topics are converted to Web pages for display:
+  - default and user selectable per session
+  - fully configurable look and feel
+  - apply skins across an entire TWiki web, or to a single displayed page
+  - use included skins and easily create new ones
+  - try the <code>**[Printable]**</code> skin below: stripped down headers and footers suitable for clean hard copy
+- plug-ins
+  - new feature packages
+  - developer community evolving existing and new capabilities
+- add-ons
+  - enhanced capability without an interface to users
+- [[FileAttachment]]
+  - upload files through your browser to the TWiki server
+  - attach any type of file (documents, images, applications) for viewing online, storage or sharing downloads with others
+  - upload revisions of existing files with automatic backup of all previous revisions
+- formatted search
+  - embedded searches of topics, data and meta-data, optional regular expressions
+  - custom formatting for outputting lists or tables, optional layout, headings, summary, etc.
+- variables
+  - similar to a command line context with site wide and locally defined variables
+  - over-ride topic, TWiki web or site
+- [[forms|TWiki/TWikiForms]]
+  - store database-style info alongside the free-form topic content
+  - accesses meta-data
+  - use text fields and boxes, radio buttons, pulldown selector menus, checkboxes
+  - create your own forms to tag topics to later search, sort and display
+- [[renaming, moving, and deleting|Main/WebHome#RenamingTopics]]
+  - rename a topic and automatically update all of the links to it, site-wide
+  - move a topic from one TWiki web to another
+  - safely delete a topic to a special Trash web (invisible, but recoverable from the Web server if necessary)
+- many more features...
 
-The configuration of your TWiki site and your own user account determine which of these features you can use.
+The configuration of your TWiki site, skins and your personal user account can modify the way these features are used and presented to you.
 
 <a name="EditingPages"></a>
 
-## <a name="How to create and edit a page"></a> How to create and edit a page
+## <a name="Creating and editing topics"></a> Creating and editing topics
+
+A primary purpose of TWiki is to make it incredibly easy for you to add and edit information on existing topics, create new topics, and link between TWiki topics.
 
-Adding and editing information on existing pages, and creating new pages, is TWiki's main function.
+- **To modify a topic**: click the <code>**Edit**</code> link in the toolbar at the bottom left of every page (using the Default skin). An editing window appears. Type away. Use the [[GoodStyle]] and [[TextFormattingRules]] links to get pop-up window help.
+  - Click <code>**Preview Changes**</code> to see how your edit looks.
+  - Click <code>**Save Changes**</code> to save.
 
-- To modify a topic, click the <code>**[Edit]**</code> link at the bottom left of every page. An editing window appears. Type away. Use the [[GoodStyle]] and [[TextFormattingRules]] links to get pop-up window help.
-  - Click <code>**[Preview Changes]**</code> to see how your edit looks.
-  - Click <code>**[Save Changes]**</code> to save.
+- **To add a new topic**: the simplest way is to type a new [[WikiName]] in 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.
+  - 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.
+  - %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 %TOPIC%, in the <code>**TWiki**</code> web, so that's all you need to type on any topic in this web. But to link to %TOPIC% from a topic in the <code>**Main**</code> web, you have to type <code>**TWiki.%TOPIC%**</code> - <code>**Webname.TopicName**</code>. It's easy.
 
-- To add a new page, the simplest way is to type a new [[WikiName]] on an existing page. When the page 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 page now exists.
+Another way to add a topic is to type a new topic name in the Go box or an unknown topic URL. You can type in either a [[WikiName]] to create the topic in the current web or Web.TopicName to create a topic in a different web than the current page. Topics created with the Go box or URLs do not have parent meta-data defined.
 
 <a name="OtherFeatures"></a>
 
-## <a name="How to attach files and use othe"></a> How to attach files and use other features
+## <a name="Other features"></a> Other features
 
-The color-coded control strip at the bottom of every page displays a series of links, including <code>**[Attach]**</code> (for attachments), <code>**[Ref-by]**</code> (to display referring pages), and <code>**[More]**</code>, which opens a new screen of additional controls).
+The color-coded toolbar at the bottom of every topic displays a series of links, including:
 
-- Most controls are self-explanatory, and also include explanatory text and help links.
-- Experiment. You can always cancel or go Back whenever you like.
-- Get in-depth info from the [[complete documentation|TWiki/WebHome]], including the User's Guide and Reference Manual.
+- <code>**[Attach]**</code> - pops a new screen for [[FileAttachments]]
+- <code>**[Ref-By]**</code> - displays all the TWiki topics with links to the current topic
+- <code>**[Diffs]**</code> - generates a page showing every change made to the current topic, with names, dates, and changes made (diffs)
+- <code>**r1.3 | &gt; | r1.2**</code> _(ex)_ - view most recent revision and changes
+- <code>**[More]**</code> - opens up a new screen containing additional controls
+
+It looks complicated, but the basics you need to begin with are very simple to use. The flexible and optional features are ready when you care to learn about them - 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 additional features are there, but only if you need them!
+
+- Some controls are self-explanatory and also include instructions and help links.
+- **Experiment**. You can always <code>**Cancel**</code> an edit or (using revision control) go Back whenever you like.
+- Get **in-depth info** from the [[complete documentation|TWiki/WebHome]], including the User's Guide, Configuration Manual and TWiki Reference.
 
 <a name="RenamingTopics"></a>
 
-## <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 page
+## <a name="Renaming, moving or deleting top"></a> Renaming, moving or deleting topics
+
+You can rename, move and delete individual topics 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 access permissions.
+
+1. Go to the top you want to change, click <code>**More &gt; Rename/move**</code>
+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)
+3. **To rename:** fill in a new [[WikiName]] (otherwise, leave the current topic name)
+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;
+5. Click <code>**Rename/move**</code>: the topic is renamed and/or moved, and the checked links to the topic are updated.
+  - Any problems are listed - take note, and you can fix them later.
+  - 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>.
+
+%H% Deleting means moving a topic to the Trash web. Since all webs share the one Trash, name conflicts may come up.
 
-You can now rename, move and delete individual topics from your browser. All three options are available by clicking **More** 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. In any case, all three are similar and extremely self-explanatory.
+<a name="RevisionRollback"></a>
 
-1. On the topic you want to change, click **More** &gt; **Rename/move**
-2. To move or delete: select the target web (`Trash` for delete)from the pull-down menu; otherwise, leave on the current web
-3. To rename: fill in a new [[WikiName]] (otherwise, leave the current topic name)
-4. To update occurrences of the topic name on other pages: From the list of pages that link to the topic, check or uncheck each entry as you desire - only checked links will be updated;
-5. Click **Rename/move**: the topic will be renamed and links to the topic updated.
-  - Any problems are listed ; you can change them later.
-  - If a referring page can't be update because it's locked (ex: someone's editing), it appears on an alert. You can missed pages later by again pressing **Rename/move**.
+## <a name="Reviewing and Reverting"></a> Reviewing and Reverting
 
-%H% Deleting means moving the topic to the Trash web. Since all webs share the one Trash, name conflicts may come up.
+RCS revision control automatically saves all topic changes. To look at earlier versions of a topic, click on `Diffs` link in topic commands. If you would like to revert to an earlier version or reclaim part of an earlier version, just copy from the old topic revision to the current topic revision. This is a step by step set of instructions:
 
-%X% **NOTE:** Keep in mind that moving a topic from a view-restricted web to a public web or the Trash web will compromise security.
+1. In the `Diffs` view, take note of what version of the topic you want to reclaim and then return to `View`.
+2. Select `More` in the topic commands.
+3. Under "View previous topic revision," enter the version number you want to reclaim and check "raw text format." Then click on "View revision."
+4. Select either the portion of that version you want to reclaim or the entire text of the topic if you want to revert completely to that version. Select `Copy` under your browser's `Edit` menu.
+5. Return to the most recent version of the topic and select `Edit` from the topic commands.
+6. Either paste in the portion of the topic you wish to reclaimed or replace the entire text with the text you copied from the earlier version.
+7. Preview and save the topic.
 
 See: [[ManagingTopics|Main/TWikiDocumentation#Managing_Topics]] for more details.
 
-_Last updated: [[MikeMannix]] - 30 Oct 2001_<br />
+-- [[MikeMannix]] - 22 May 2002 %BR% -- [[GrantBow]] - 17 Jan 2003 %BR%