head 1.20; access; symbols; locks; strict; comment @# @; 1.20 date 2006.06.25.16.26.27; author TWikiContributor; state Exp; branches; next 1.19; 1.19 date 2006.04.01.05.55.16; author TWikiContributor; state Exp; branches; next 1.18; 1.18 date 2006.02.01.12.01.20; author TWikiContributor; state Exp; branches; next 1.17; 1.17 date 2004.08.16.05.06.46; author PeterThoeny; state Exp; branches; next 1.16; 1.16 date 2004.08.15.21.24.28; author PeterThoeny; state Exp; branches; next 1.15; 1.15 date 2003.07.26.21.04.05; author PeterThoeny; state Exp; branches; next 1.14; 1.14 date 2003.04.15.05.13.21; author PeterThoeny; state Exp; branches; next 1.13; 1.13 date 2003.03.16.05.56.13; author PeterThoeny; state Exp; branches; next 1.12; 1.12 date 2003.02.01.11.46.31; author PeterThoeny; state Exp; branches; next 1.11; 1.11 date 2002.05.12.19.10.00; author MikeMannix; state Exp; branches; next 1.10; 1.10 date 2001.12.29.10.21.00; author MikeMannix; state Exp; branches; next 1.9; 1.9 date 2001.10.31.01.39.06; author MikeMannix; state Exp; branches; next 1.8; 1.8 date 2001.10.02.07.26.02; author MikeMannix; state Exp; branches; next 1.7; 1.7 date 2001.09.16.06.09.02; author MikeMannix; state Exp; branches; next 1.6; 1.6 date 2001.09.14.06.18.41; author PeterThoeny; state Exp; branches; next 1.5; 1.5 date 2001.09.12.02.23.20; author MikeMannix; state Exp; branches; next 1.4; 1.4 date 2001.09.06.08.50.25; author JohnTalintyre; state Exp; branches; next 1.3; 1.3 date 2001.09.01.09.28.38; author MikeMannix; state Exp; branches; next 1.2; 1.2 date 2001.08.30.16.26.23; author MikeMannix; state Exp; branches; next 1.1; 1.1 date 2001.08.30.12.52.22; author MikeMannix; state Exp; branches; next ; desc @none @ 1.20 log @buildrelease @ text @%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="20"}% %META:TOPICPARENT{name="WebHome"}% ---+!! TWiki Topics %TOC% The basic building block of a TWiki site is called a __topic__, identified by a unique, hopefully descriptive, %TWIKIWEB%.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. ---++ Characteristics A TWiki topic is a rich information unit. *Each* topic has: * name * instantly identify what the topic is about * link to it from other topics just by typing in its WikiWord * content * edited by simply clicking the [[#PageBottom][edit link]] * enter plain text, leaving a blank space between paragraphs like e-mail (all you need) * enter simple TWiki shorthand to represent complex HTML and special TWiki variables * 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 * [[%TWIKIWEB%.TWikiAccessControl][access control]] * independently determine who can see, edit, rename, move or delete topics * set permissions by individual users and user groups * over-ride topic, TWiki web or site * revision control * topic changes are automatically saved * efficiently stores every change made to the original version * 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 its 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: * [[%TWIKIWEB%.TWikiSkins][TWiki Skins]] 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 ==Printable== 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 * [[%TWIKIWEB%.TWikiForms][forms]] * 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 * [[#RenamingTopics][renaming, moving, and deleting]] * 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, skins and your personal user account can modify the way these features are used and presented to you. #EditingPages ---++ 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. * *To modify a topic*: click the ==Edit== 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 ==Preview Changes== to see how your edit looks. * Click ==Save Changes== 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.
__Example:__ This is %TOPIC%, in the ==TWiki== 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 ==%MAINWEB%== web, you have to type ==%TWIKIWEB%.%TOPIC%== - ==Webname.TopicName==. It's easy. 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. #OtherFeatures ---++ Other features The color-coded toolbar at the bottom of every topic displays a series of links, including: * ==Attach== - pops a new screen for FileAttachments * ==Backlinks== - displays all the TWiki topics with links to the current topic * ==History== - generates a page showing every change made to the current topic, with names, dates, and changes made (diffs) * ==r3 > r2 > r1== - view most recent revision and changes * ==More== - 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 ==Cancel== an edit or (using revision control) go Back whenever you like. * Get *in-depth info* from the [[%TWIKIWEB%.%HOMETOPIC%][complete documentation]], including the User's Guide, Configuration Manual and TWiki Reference. #RenamingTopics ---++ Renaming, moving or deleting topics You can rename, move and delete individual topics 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, depending on your site set-up and access permissions. 1. Go to the top you want to change, click ==More > Rename/move== 1. *To move or delete:* select the target web (==Trash== to delete)from the pull-down menu (otherwise, leave on the current web) 1. *To rename:* fill in a new WikiName (otherwise, leave the current topic name) 1. *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; 1. Click ==Rename/move==: 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 ==Rename/move==. __%H% Note:__ Deleting means moving a topic to the Trash web. Since all webs share the one Trash, name conflicts may come up. #RevisionRollback ---++ Reviewing and Reverting 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: 1 In the =Diffs= view, take note of what version of the topic you want to reclaim and then return to =View=. 1 Select =More= in the topic commands. 1 Under "View previous topic revision," enter the version number you want to reclaim and check "raw text format." Then click on "View revision." 1 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. 1 Return to the most recent version of the topic and select =Edit= from the topic commands. 1 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. 1 Save the topic. See: [[TWikiDocumentation#Managing_Topics][ManagingTopics]] for more details. --- __Related Topics:__ UserDocumentationCategory, AdminDocumentationCategory @ 1.19 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="19"}% d34 1 a34 1 * relevant when searching for a topic, referencing it or typing in it's URL @ 1.18 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="18"}% d12 33 a44 33 * name * instantly identify what the topic is about * link to it from other topics just by typing in its WikiWord * content * edited by simply clicking the [[#PageBottom][edit link]] * enter plain text, leaving a blank space between paragraphs like e-mail (all you need) * enter simple TWiki shorthand to represent complex HTML and special TWiki variables * 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 * [[%TWIKIWEB%.TWikiAccessControl][access control]] * independently determine who can see, edit, rename, move or delete topics * set permissions by individual users and user groups * over-ride topic, TWiki web or site * revision control * topic changes are automatically saved * efficiently stores every change made to the original version * 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 d48 31 a78 31 * [[%TWIKIWEB%.TWikiSkins][TWiki Skins]] 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 ==Printable== 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 * [[%TWIKIWEB%.TWikiForms][forms]] * 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 * [[#RenamingTopics][renaming, moving, and deleting]] * 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... d87 8 a94 8 * *To modify a topic*: click the ==Edit== 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 ==Preview Changes== to see how your edit looks. * Click ==Save Changes== 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.
__Example:__ This is %TOPIC%, in the ==TWiki== 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 ==%MAINWEB%== web, you have to type ==%TWIKIWEB%.%TOPIC%== - ==Webname.TopicName==. It's easy. d103 5 a107 5 * ==Attach== - pops a new screen for FileAttachments * ==Backlinks== - displays all the TWiki topics with links to the current topic * ==History== - generates a page showing every change made to the current topic, with names, dates, and changes made (diffs) * ==r3 > r2 > r1== - view most recent revision and changes * ==More== - opens up a new screen containing additional controls d111 3 a113 3 * Some controls are self-explanatory and also include instructions and help links. * *Experiment*. You can always ==Cancel== an edit or (using revision control) go Back whenever you like. * Get *in-depth info* from the [[%TWIKIWEB%.%HOMETOPIC%][complete documentation]], including the User's Guide, Configuration Manual and TWiki Reference. d120 7 a126 7 1. Go to the top you want to change, click ==More > Rename/move== 1. *To move or delete:* select the target web (==Trash== to delete)from the pull-down menu (otherwise, leave on the current web) 1. *To rename:* fill in a new WikiName (otherwise, leave the current topic name) 1. *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; 1. Click ==Rename/move==: 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 ==Rename/move==. d133 7 a139 7 1 In the =Diffs= view, take note of what version of the topic you want to reclaim and then return to =View=. 1 Select =More= in the topic commands. 1 Under "View previous topic revision," enter the version number you want to reclaim and check "raw text format." Then click on "View revision." 1 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. 1 Return to the most recent version of the topic and select =Edit= from the topic commands. 1 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. 1 Save the topic. @ 1.17 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1092632806" format="1.0" version="1.17"}% d14 1 a14 1 * link to it from other topics just by typing it in it's WikiWord d17 2 a18 2 * 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 d53 1 a53 1 * try the ==[Printable]== skin below: stripped down headers and footers suitable for clean hard copy d103 5 a107 5 * ==[Attach]== - pops a new screen for FileAttachments * ==[Ref-By]== - displays all the TWiki topics with links to the current topic * ==[Diffs]== - generates a page showing every change made to the current topic, with names, dates, and changes made (diffs) * ==r1.3 | > | r1.2== _(ex)_ - view most recent revision and changes * ==[More]== - opens up a new screen containing additional controls d128 1 a128 1 %H% Deleting means moving a topic to the Trash web. Since all webs share the one Trash, name conflicts may come up. d139 1 a139 1 1 Preview and save the topic. d142 2 a143 4 -- TWiki:MikeMannix - 22 May 2002 %BR% -- TWiki:Main.GrantBow - 17 Jan 2003 %BR% %META:TOPICMOVED{by="MikeMannix" date="1021230286" from="TWiki.TWikiPages" to="TWiki.TWikiTopics"}% @ 1.16 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1092605068" format="1.0" version="1.16"}% d143 1 a143 1 -- TWiki::Main.GrantBow - 17 Jan 2003 %BR% @ 1.15 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1059253445" format="1.0" version="1.15"}% d3 142 a144 141 ---+!! TWiki Topics %TOC% The basic building block of a TWiki site is called a __topic__, identified by a unique, hopefully descriptive, %TWIKIWEB%.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. ---++ Characteristics A TWiki topic is a rich information unit. *Each* topic has: * 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 [[#PageBottom][edit link]] * 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 * [[%TWIKIWEB%.TWikiAccessControl][access control]] * independently determine who can see, edit, rename, move or delete topics * set permissions by individual users and user groups * over-ride topic, TWiki web or site * revision control * topic changes are automatically saved * efficiently stores every change made to the original version * 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: * [[%TWIKIWEB%.TWikiSkins][TWiki Skins]] 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 ==[Printable]== 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 * [[%TWIKIWEB%.TWikiForms][forms]] * 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 * [[#RenamingTopics][renaming, moving, and deleting]] * 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, skins and your personal user account can modify the way these features are used and presented to you. #EditingPages ---++ 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. * *To modify a topic*: click the ==Edit== 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 ==Preview Changes== to see how your edit looks. * Click ==Save Changes== 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.
__Example:__ This is %TOPIC%, in the ==TWiki== 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 ==%MAINWEB%== web, you have to type ==%TWIKIWEB%.%TOPIC%== - ==Webname.TopicName==. It's easy. 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. #OtherFeatures ---++ Other features The color-coded toolbar at the bottom of every topic displays a series of links, including: * ==[Attach]== - pops a new screen for FileAttachments * ==[Ref-By]== - displays all the TWiki topics with links to the current topic * ==[Diffs]== - generates a page showing every change made to the current topic, with names, dates, and changes made (diffs) * ==r1.3 | > | r1.2== _(ex)_ - view most recent revision and changes * ==[More]== - 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 ==Cancel== an edit or (using revision control) go Back whenever you like. * Get *in-depth info* from the [[%TWIKIWEB%.%HOMETOPIC%][complete documentation]], including the User's Guide, Configuration Manual and TWiki Reference. #RenamingTopics ---++ Renaming, moving or deleting topics You can rename, move and delete individual topics 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, depending on your site set-up and access permissions. 1. Go to the top you want to change, click ==More > Rename/move== 1. *To move or delete:* select the target web (==Trash== to delete)from the pull-down menu (otherwise, leave on the current web) 1. *To rename:* fill in a new WikiName (otherwise, leave the current topic name) 1. *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; 1. Click ==Rename/move==: 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 ==Rename/move==. %H% Deleting means moving a topic to the Trash web. Since all webs share the one Trash, name conflicts may come up. #RevisionRollback ---++ Reviewing and Reverting 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: 1 In the =Diffs= view, take note of what version of the topic you want to reclaim and then return to =View=. 1 Select =More= in the topic commands. 1 Under "View previous topic revision," enter the version number you want to reclaim and check "raw text format." Then click on "View revision." 1 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. 1 Return to the most recent version of the topic and select =Edit= from the topic commands. 1 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. 1 Preview and save the topic. See: [[TWikiDocumentation#Managing_Topics][ManagingTopics]] for more details. -- MikeMannix - 22 May 2002 %BR% -- Main.GrantBow - 17 Jan 2003 %BR% @ 1.14 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1050383601" format="1.0" version="1.14"}% d94 1 a94 1 __Example:__ This is TWikiTopic, in the ==TWiki== 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 ==%MAINWEB%== web, you have to type ==%TWIKIWEB%.TWikiTopics== - ==Webname.TopicName==. It's easy. @ 1.13 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1047794173" format="1.0" version="1.13"}% d48 1 a48 2 * skins * fully configurable look and feel for all topics d50 4 a73 4 * [[%TWIKIWEB%.TWikiSkins][TWiki Skins]] to customize the look of headers and footers when topics are converted to Web pages for display: * apply skins across an entire TWiki web, or to a single displayed page * use included skins and easily create new ones * try the ==[Printable]== skin below: stripped down headers and footers suitable for clean hard copy @ 1.12 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1044099991" format="1.0" version="1.12"}% d22 1 a22 1 * do all of this through whatever web browswer you are familiar with @ 1.11 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="1021230600" format="1.0" version="1.11"}% d3 1 a3 1 ---+ TWiki Topics d6 1 a6 1 The basic building block of a TWiki site is called a __topic__, identified by a unique, hopefully descriptive, %TWIKIWEB%.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, d8 1 a8 1 ---++ Topic Features d10 1 a10 1 A TWiki topic is a self-contained information unit rich in features. Each topic has: d12 1 a12 1 * a WikiWord title that lets you: d14 3 a16 2 * link to it from other topics just by typing it in * an [[#PageBottom][edit link]] to a collaboration area where you can: d18 49 a66 4 * use simple TWiki shorthand to represent complex HTML and special TWiki tags * include links to other topics, Web sites, images, sound files, or anything else you can put on a regular Web page, using easy shorthand * do all of that within your browswer, with no HTML editor, just simple codes and a handy pop-up quick reference panel * extra [[%TWIKIWEB%.TWikiForms][Web forms]] option: d68 1 a70 4 * 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 online, storage or sharing downloads with others * upload revisions of existing files with automatic backup of all previous versions d75 1 a75 1 * browser-based controls for [[#RenamingTopics][renaming, moving, and deleting]] topics: a78 12 * flexible [[%TWIKIWEB%.TWikiAccessControl][access control]]: * independently determine who can see, edit, rename, move or delete topics * set permissions by individual users and user groups * RCS revision control to automatically save all topic changes: * efficiently stores every change made to the original version * 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 * a referred-by search that list all topics that link to a particular topic * hierarchical parent-child topic navigation: * automatically links a new topic as the "child" of the topic it was created from * allows manual assignment of parent topic from a list of all topics in the local web * offers navigation displays, by topic parent, or by related topic d81 1 a81 1 The configuration of your TWiki site and your personal user account determine which of these features are installed and available to you. d84 1 a84 1 ---++ How to create and edit a topic d86 1 a86 1 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. d88 1 a88 1 * *To modify a topic*, click the ==Edit== 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. d92 1 a92 1 * *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. d97 3 d101 1 a101 1 ---++ How to attach files and use other features d105 10 a114 10 * ==[Ref-By]== - displays all the TWiki topics with links to the topic you're on * ==[Diffs]== - generates a page showing every change made to the topic you're on, with names, dates, and changes made * ==r1.3 | > | r1.2== _(ex)_ - some specific previous version stuff that you can check out on your own * ==[More]== - opens up a whole new screen of additional controls 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! * Most controls are *self-explanatory*, and also include instructions and help links. * *Experiment*. You can always ==Cancel== or go Back whenever you like. * Get *in-depth info* from the [[%TWIKIWEB%.%HOMETOPIC%][complete documentation]], including the User's Guide and Configuration Manual and TWiki Reference. d117 1 a117 1 ---++ How to rename, move or delete a topic d119 1 a119 1 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, depending on your site set-up and personal permissions. In any case, all three are similar and extremely easy to use. d131 10 d143 2 a144 1 -- Main.MikeMannix - 12 May 2002 @ 1.10 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="1009621260" format="1.0" version="1.10"}% d3 1 a3 1 ---+ TWiki Pages d6 1 a6 1 Each page in a TWiki web is called a __topic__, identified by a unique, hopefully descriptive, %TWIKIWEB%.WikiWord title. A topic is the basic building block of a TWikiSite. d8 1 a8 1 ---++ Page Features d13 2 a14 2 * instantly identify what the page is about * link to it from other pages just by typing it in d16 6 a21 5 * enter plain or HTML-formatted text (plain text is all you need) * use simple TWiki shorthand to enter HTML and special TWiki functions * include Web links, images, anything else you can put on a Web page * an extra [[%TWIKIWEB%.TWikiForms][Web forms]] option: * store database-style info alongside the free-form page content d23 1 a23 2 * create your own forms to gather searchable, sortable input * select one form per topic from as many choices as you like d26 1 a26 1 * attach any type of file (documents, images, applications) for viewing or downloading d28 2 a29 2 * [[%TWIKIWEB%.TWikiSkins][TWiki Skins]] to customize the look of headers and footers: * apply skins across an entire TWiki web, or to a single page d31 4 a34 4 * try the ==[Printable]== skin below: stripped down headers and footers suitable for printing * browser-based controls for [[#RenamingTopics][renaming, moving, and deleting]] pages: * rename a page and automatically update all of the links to it, site-wide * move a page from one TWiki web to another a39 1 * uses the established standard RCS (Revision Control System) d41 3 a43 3 * lets you compare changes between any two versions or review all chnages * displays any previous version as a regular Web page or as raw text * referred-by searches that list all topics that link to a particular page d45 2 a46 2 * 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 d48 1 a48 1 * many more features - see TWikiMetaData, for a start - as well as special TWiki effects that you can store on a top (start with TWikiVariables)... d53 1 a53 1 ---++ How to create and edit a page d55 1 a55 1 Making it incredibly easy for you to add and edit information on existing pages, create new pages, and link all TWiki pages, is TWiki's main function. d57 8 a64 8 * *To modify a page*, click the ==[Edit]== 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. * Click ==[Preview Changes]== to see how your edit looks. * Click ==[Save Changes]== to save. * *To add a new page*, the simplest way is to type a new WikiName on an existing page, while you're in edit mode. 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. * Go back to the page where you started, and you'll see the *?* has disappeared, and your WikiWord name is now a regular link. Type it anywhere on any page in that web, and it will be turned into a link. * %H% *One little links rule: each topic, and its WikiWord link, belongs to one unique web only.* To link _between_ webs, you must first enter the topic's web name.
For example: This is TWikiPages, in the ==TWiki== web, so that's all you need to type on any page in this web. But to link to TWikiPages from a page in the ==%MAINWEB%== web, you have to type ==TWiki.TWikiPages== - ==Web.TopicName==. It's simple. d69 4 a72 4 The color-coded toolbar at the bottom of every page displays a series of links, including: * ==[Attach]== - pops a new screen for file attachments * ==[Ref-By]== - displays all the TWiki pages with links to the page you're on * ==[Diffs]== - generates a page showing every change made to the page you're on, with names, dates, and changes d78 3 a80 3 * Most controls are self-explanatory, and also include instructions and help links. * Experiment. You can always cancel or go Back whenever you like. * Get in-depth info from the [[%TWIKIWEB%.%HOMETOPIC%][complete documentation]], including the User's Guide and Reference Manual. d83 1 a83 1 ---++ How to rename, move or delete a page d85 1 a85 1 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, depending on your site set-up and personal permissions. In any case, all three are similar and extremely easy to use. d87 1 a87 1 1. Go to the page you want to change, click ==[More] > [Rename/move]== d90 2 a91 2 1. *To update links:* From the list of pages that show links to the topic you're changing, uncheck each entry you DON'T want to update - only checked links will be updated; 1. Click ==[Rename/move]==: the topic are renamed and/or moved, and the checked links to the topic are updated. d93 1 a93 1 * If a linked page can't be updated (it may be locked because someone's editing it), an alert will appear. You can update missed pages later by again pressing ==[Rename/move]==. d95 1 a95 1 %H% Deleting means moving the topic to the Trash web. Since all webs share the one Trash, name conflicts may come up. d99 2 a100 2 _Last updated: Main.MikeMannix - 29 Dec 2001_ %META:TOPICMOVED{by="MikeMannix" date="1000261400" from="TWiki.HandlingTopics" to="TWiki.TWikiPages"}% @ 1.9 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="1004492346" format="1.0" version="1.9"}% a2 2 %INCLUDE{"DocsUserNote"}% a3 1 d6 1 a6 1 Each page in a TWiki web is called a __topic__, defined by its meaningful, descriptive %TWIKIWEB%.WikiWord title. d10 1 a10 1 A TWiki topic is a self-contained information unit rich in features: d14 4 a17 4 * 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) d19 2 a20 2 * an extra [[%TWIKIWEB%.TWikiForms][forms input]] option: * store structured info alongside the free-form page content d22 2 a23 1 * select from one or many different input forms, with all data preserved d27 1 a27 1 * make changes and update existing files d29 3 a31 1 * apply skins across an entire TWiki web level, or to a single page d33 1 a33 1 * rename a page and automatically update all the references to it, site-wide d35 1 a35 1 * safely delete a topic to a special Trash web (invisible, but accessible to the TWiki administrators if needed) d39 1 a39 1 * revision control automatically saves topic changes: d42 3 a44 2 * 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 d48 2 a49 1 * offers navigation displays, by topic parent, or by related topic d51 1 a51 1 The configuration of your TWiki site and your own user account determine which of these features you can use. d56 1 a56 1 Adding and editing information on existing pages, and creating new pages, is TWiki's main function. d58 1 a58 1 * To modify a topic, click the ==[Edit]== 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. d62 4 a65 1 * 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. d70 6 a75 1 The color-coded control strip at the bottom of every page displays a series of links, including ==[Attach]== (for attachments), ==[Ref-by]== (to display referring pages), and ==[More]==, which opens a new screen of additional controls). d77 3 a79 1 * Most controls are self-explanatory, and also include explanatory text and help links. d81 1 a81 1 * Get in-depth info from the [[%TWIKIWEB%.%HOMETOPIC%][complete documentation]], including the User's Guide and Reference Manual. d86 1 a86 9 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. 1. On the topic you want to change, click *More* > *Rename/move* 1. To move or delete: select the target web (=Trash= for delete)from the pull-down menu; otherwise, leave on the current web 1. To rename: fill in a new WikiName (otherwise, leave the current topic name) 1. 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; 1. 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*. d88 7 a94 1 %H% Deleting means moving the topic to the Trash web. Since all webs share the one Trash, name conflicts may come up. d96 1 a96 1 %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. d100 1 a100 1 _Last updated: Main.MikeMannix - 30 Oct 2001_
@ 1.8 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="1002007562" format="1.0" version="1.8"}% d3 2 d13 1 a13 1 A TWiki topic is a self-contained information unit, rich in features that include: d17 1 a17 1 * autolink to it from other pages simply by typing it in d19 5 a23 5 * enter plain or HTML-formatted text * work with simple TWikiShorthand (the power of HTML plus special TWiki tags) * include links, images, anything else you can put on a regular Web page * an optional [[TWikiDocumentation#TWiki_Form_Templates][form]] feature to: * store structured info along with the freeform page content d25 2 a26 2 * select the right input template for each page from a choice of multiple form * a FileAttachment function that allows you to: d28 1 a28 1 * attach any size and type of file (documents, images, applications) for viewing or downloading d30 2 a31 1 * [[TWikiDocumentation#TWiki_Skins][TWiki Skins]] that work on the web level, but can also be used to customize the look of headers and footers on a single page d33 1 a33 1 * rename a page and automatically update all the links referring to it, site-wide d36 2 a37 2 * flexible [[TWikiDocumentation#TWiki_Access_Control][access control]]: * independently determine who can view, edit, rename, move or delete topics d39 20 d60 10 a69 1 The configuration of your TWiki site and your own user account determine which of these features you can use. d74 1 a74 1 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. Access to one or more of these three options, for a topic, a web or an entire site, may be available to administrators only. In any case, all three are similar and extremely self-explanatory. d76 1 a76 1 1. On the page you want to change, click *More* > *Rename/move* d81 2 a82 2 * Any problems are listed; you can change them later. * If a referring page can't be update because it's locked (ex: someone is editing), it appears on an alert. You can update missed pages later by again pressing *Rename/move*. d88 1 a88 1 See [[TWikiDocumentation#Managing_Topics][ManagingTopics]] for more details. d90 1 a90 1 -- MikeMannix - 02 Oct 2001
@ 1.7 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="1000620542" format="1.0" version="1.7"}% d11 1 a11 1 A TWiki topic is a self-contained information unit rich in features: d15 1 a15 1 * automatically link to it from other pages d17 5 a21 5 * 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 [[TWikiDocumentation#TWiki_Form_Templates][forms input]] option: * store structured info alongside the free-form page content d23 2 a24 2 * select from one or many different input forms, with all data preserved * a FileAttachment feature that lets you: d26 1 a26 1 * attach any type of file (documents, images, applications) for viewing or downloading d28 1 a28 1 * [[TWikiDocumentation#TWiki_Skins][TWiki Skins]] work on the web level, but can also be used to customize the look of headers and footers on a single pages d30 1 a30 1 * rename a page and automatically update all the references to it, site-wide d34 1 a34 1 * independently determine who can see, edit, rename, move or delete topics d37 1 a37 1 Depending on the set-up of your TWiki site and your own user account, you have several or all of the above. d42 1 a42 1 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. d44 1 a44 1 1. On the topic you want to change, click *More* > *Rename/move* d49 2 a50 2 * 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*. d52 1 a52 1 *Note:* Deleting means moving the topic to the Trash web. Since all webs share the one Trash, name conflicts may come up. d54 1 a54 1 *Note:* Keep in mind that moving a topic from a view restricted web to a public web or the Trash web will compromize security. d57 2 @ 1.6 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1000448321" format="1.0" version="1.6"}% a2 2 %INCLUDE{"UtilTempDocNote"}% @ 1.5 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="1000264948" format="1.0" version="1.5"}% d54 3 a56 1 *Note:* Deleting means moving the topic to the Trash web. Since all webs share the one Trash, name conflicts may come up. @ 1.4 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="JohnTalintyre" date="999766225" format="1.0" version="1.4"}% d3 1 a3 1 ---++ How to rename, move, or delete a topic d5 1 a5 1 You can now rename, move and delete individual topics from your browser. All three options are available by clicking the [Rename/Move] on the lower toolbar. The access settings for a particular page, web or entire site may disable one or more of the three options. In any case, all three are similar and extremely self-explanatory on-screen. d7 46 a52 7 1 On the topic you want to change, click *Rename/move* 1 To move or delete, from the pull-down menu, select the target web ("Trash" for delete); otherwise, leave on the current web 2 To rename, fill in new WikiName, or leave the default current topic anme 3 You will be warned if there are locks or if there is a name clash - adjust accordingly, or [Cancel] 4 A list of pages that link to the topic will be listed, checked by default: checked links will be updated; clear the checkbox to prevent any unwanted changes 5 Click [Rename/Move]: the topic will be renamed and links to the topic updated. * If any of the referring pages are locked then they will be listed. You can correct these later by again pressing Rename/Move. d56 2 a57 1 See ManagingTopics for more details. @ 1.3 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="999336518" format="1.0" version="1.3"}% d16 2 @ 1.2 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="999188783" format="1.0" version="1.2"}% d3 1 a3 1 ---++ Rename/move/delete a topic d5 1 a5 1 You can now rename, move and delete individual topics from your browser. All three options are available by clicking the *Rename/move* on the lower toolbar. The access settings for a particular page, web or entire site may disable one or more of the three options. In any case, all three are similar and extremely self-explanatory on-screen. d10 1 a10 1 3 You will be warned if there are locks or if there is a name clash - adjust accordingly, or Cancel d12 1 a12 1 5 Click Rename/Move: the topic will be renamed and links to the topic updated. @ 1.1 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="MikeMannix" date="999179978" format="1.0" version="1.1"}% @