none
[openafs-wiki.git] / TWiki / TWikiTopics.mdwn
1 # <a name="TWiki Pages"></a> TWiki Pages
2
3 <div>
4   <ul>
5     <li><a href="#TWiki Pages"> TWiki Pages</a><ul>
6         <li><a href="#Page Features"> Page Features</a></li>
7         <li><a href="#How to create and edit a page"> How to create and edit a page</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 page</a></li>
10       </ul>
11     </li>
12   </ul>
13 </div>
14
15 Each page in a TWiki web is called a **_topic_**, defined by its meaningful, descriptive [[WikiWord]] title.
16
17 ## <a name="Page Features"></a> Page Features
18
19 A TWiki topic is a self-contained information unit rich in features:
20
21 - a [[WikiWord]] title that lets you:
22   - instantly identify what the page is about
23   - automatically link to it from other pages
24 - an edit-anywhere collaboration area where you can:
25   - enter plain or fully-HTML formatted text
26   - work with simple TWiki editing shorthand (that includes HTML mark-up and special TWiki functions)
27   - include Web links, images, anything else you can put on a Web page
28 - an extra [[forms input|TWiki/TWikiForms]] option:
29   - store structured info alongside the free-form page content
30   - use text fields and boxes, radio buttons, pulldown selector menus, checkboxes
31   - select from one or many different input forms, with all data preserved
32 - a [[FileAttachment]] feature that lets you:
33   - upload files through your browser to the TWiki server
34   - attach any type of file (documents, images, applications) for viewing or downloading
35   - make changes and update existing files
36 - [[TWiki Skins|TWiki/TWikiSkins]] to customize the look of headers and footers:
37   - apply skins across an entire TWiki web level, or to a single page
38 - browser-based controls for [[renaming, moving, and deleting|Main/WebHome#RenamingTopics]] pages:
39   - rename a page and automatically update all the references to it, site-wide
40   - move a page from one TWiki web to another
41   - safely delete a topic to a special Trash web (invisible, but accessible to the TWiki administrators if needed)
42 - flexible [[access control|TWiki/TWikiAccessControl]]:
43   - independently determine who can see, edit, rename, move or delete topics
44   - set permissions by individual users and user groups
45 - revision control automatically saves topic changes:
46   - uses the established standard RCS (Revision Control System)
47   - efficiently stores every change made to the original version
48   - allows comparison of changes between any two versions, and review of any version, as formatted or raw text
49 - referred-by searches that list all topics in a web or site wide that link to a particular page
50 - hierarchical parent-child topic navigation:
51   - automatically links a new page as the "child" of the page it was created from
52   - allows manual assignment of parent page from a list of all topics in the local web
53   - offers navigation displays, by topic parent, or by related topic
54
55 The configuration of your TWiki site and your own user account determine which of these features you can use.
56
57 <a name="EditingPages"></a>
58
59 ## <a name="How to create and edit a page"></a> How to create and edit a page
60
61 Adding and editing information on existing pages, and creating new pages, is TWiki's main function.
62
63 - 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.
64   - Click <code>**[Preview Changes]**</code> to see how your edit looks.
65   - Click <code>**[Save Changes]**</code> to save.
66
67 - 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.
68
69 <a name="OtherFeatures"></a>
70
71 ## <a name="How to attach files and use othe"></a> How to attach files and use other features
72
73 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).
74
75 - Most controls are self-explanatory, and also include explanatory text and help links.
76 - Experiment. You can always cancel or go Back whenever you like.
77 - Get in-depth info from the [[complete documentation|TWiki/WebHome]], including the User's Guide and Reference Manual.
78
79 <a name="RenamingTopics"></a>
80
81 ## <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
82
83 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.
84
85 1. On the topic you want to change, click **More** &gt; **Rename/move**
86 2. To move or delete: select the target web (`Trash` for delete)from the pull-down menu; otherwise, leave on the current web
87 3. To rename: fill in a new [[WikiName]] (otherwise, leave the current topic name)
88 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;
89 5. Click **Rename/move**: the topic will be renamed and links to the topic updated.
90   - Any problems are listed ; you can change them later.
91   - 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**.
92
93 %H% Deleting means moving the topic to the Trash web. Since all webs share the one Trash, name conflicts may come up.
94
95 %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.
96
97 See: [[ManagingTopics|Main/TWikiDocumentation#Managing_Topics]] for more details.
98
99 _Last updated: [[MikeMannix]] - 30 Oct 2001_<br />