data/TWiki/InstantEnhancements.txt,v
changeset 0 414e01d06fd5
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 head	1.7;
       
     2 access;
       
     3 symbols;
       
     4 locks; strict;
       
     5 comment	@# @;
       
     6 
       
     7 
       
     8 1.7
       
     9 date	2008.01.22.03.21.29;	author TWikiContributor;	state Exp;
       
    10 branches;
       
    11 next	1.6;
       
    12 
       
    13 1.6
       
    14 date	2007.01.16.04.11.57;	author TWikiContributor;	state Exp;
       
    15 branches;
       
    16 next	1.5;
       
    17 
       
    18 1.5
       
    19 date	2006.04.01.05.55.07;	author TWikiContributor;	state Exp;
       
    20 branches;
       
    21 next	1.4;
       
    22 
       
    23 1.4
       
    24 date	2006.02.01.12.01.17;	author TWikiContributor;	state Exp;
       
    25 branches;
       
    26 next	1.3;
       
    27 
       
    28 1.3
       
    29 date	2004.08.22.21.54.31;	author PeterThoeny;	state Exp;
       
    30 branches;
       
    31 next	1.2;
       
    32 
       
    33 1.2
       
    34 date	2004.08.15.05.33.44;	author PeterThoeny;	state Exp;
       
    35 branches;
       
    36 next	1.1;
       
    37 
       
    38 1.1
       
    39 date	2003.01.31.09.03.58;	author PeterThoeny;	state Exp;
       
    40 branches;
       
    41 next	;
       
    42 
       
    43 
       
    44 desc
       
    45 @none
       
    46 @
       
    47 
       
    48 
       
    49 1.7
       
    50 log
       
    51 @buildrelease
       
    52 @
       
    53 text
       
    54 @%META:TOPICINFO{author="TWikiContributor" date="1163619832" format="1.0" version="7"}%
       
    55 ---+!! Instant TWiki Site Enhancements
       
    56 
       
    57 These quick enhancements are aimed at improving and customising your TWiki.  New TWiki site administrators are especially encouraged to review this document for ideas before deploying a new TWikiSite. The metaphor of building a house is useful.  The listed enhancements are some of the details possible when moving into a new office or home. These small changes can make a *big* differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes.  No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics.
       
    58 
       
    59 Many of these tips are based on setting some special TWikiVariables.
       
    60 
       
    61 %S% We recommend implementing at least __some__ of these enhancements __right after installation__ to get a taste for what is possible.  Some of these tips and enhancements _should_ be implemented before or during initial roll-out.
       
    62 
       
    63 This may spark your imagination to *really* customize your site so that it's optimal for *your* users.  Slightly more advanced customization tips are listed in TWiki:TWiki.TWikiAdminCookBook.
       
    64 
       
    65 %TOC%
       
    66 
       
    67 ---
       
    68 ---++ Tips using TWiki Variables
       
    69 
       
    70 TWikiVariables are a great resource to customize your site. You need to know the variable name and decide where to put it.
       
    71 
       
    72 ---+++ Change Colors of Page Header/Footer
       
    73 
       
    74 Incredibly obvious, maybe, but some TWiki site admins don't get around to changing the default web colors right off, whether they like them or not. Simply changing the defaults will make a huge difference in the overall look. 
       
    75 
       
    76 *What we are doing*
       
    77 
       
    78 We want to set variable WEBBGCOLOR in topic WebPreferences to one of the StandardColors. <nop>WebPreferences is, as you can guess, a topic which holds all kind of preference setting for each TWiki Web[[ManagingWebs][{*}]]. Each web has its own <nop>WebPreferences, and you can set them differently for each web.
       
    79 
       
    80 *How to do it*
       
    81 
       
    82    1 Pick color code from company or product references, the StandardColors table (recommended for 8-bit client compatibility), or some other color reference. 
       
    83    2 Go to WebPreferences in each web, and edit the topic.
       
    84    3 Set your preferred WEBBGCOLOR preferences variable, and save the topic.
       
    85    4 %X% Add a new line immediately after the color code. If there is (invisible) space after the color code, the page header might get strange colors (e.g. black).
       
    86 
       
    87 It's just as easy to refine later on, so you're not locked in, just looking better.
       
    88 
       
    89 ---+++ Set Page Background Color 
       
    90 
       
    91 Without getting into the TWikiTemplates system yet, you can easily edit the ==view.tmpl== (in the =templates= directory). In the HTML at the top, the body tag has the page background hardcoded to white ==bgcolor="#ffffff"==. You can change that color value to new variable. First, define a new preferences variable in the site-level [[%LOCALSITEPREFS%]], e.g. =* Set =PAGEBGCOLOR = #d0d0d0=, then edit the ==view.tmpl== template file and change ==bgcolor="#ffffff"== to ==bgcolor="%<nop>PAGEBGCOLOR%"==. If you want, you can set the page background color individually per web, simple add a =* Set =PAGEBGCOLOR = #d0d0d0= bullet to the WebPreferences to overload the site-level preferences. (Without font color control, you'll have to stick to light colors.)
       
    92 
       
    93 ---+++ Titles-Only Topic List - !WebTopicList
       
    94 
       
    95 WebTopicList is a __good first navigation tool for new users,__ a fast-loading linked list (page titles only) of a web's topics is a quick and easy way see what's available. By default, slower, but more powerful WebIndex is used. 
       
    96 
       
    97 Without explaining what WEBTOPICLIST is, just try it: 
       
    98 
       
    99    1 Go to WebPreferences in each web, and edit the topic.
       
   100    2 In WEBTOPICLIST variable, replace =WebIndex= with =WebTopicList=, and save.
       
   101 
       
   102 ---+++ Simple way to create %RED% colored text %ENDCOLOR% and graphics
       
   103 
       
   104 This should be enabled, see the "Miscellaneous Settings" in the TWikiPreferences, . If not, look at TWiki:TWiki/TWikiPreferences. Look for variables RED, BLUE etc (which define HTML tag FONT). To copy/paste the variables defining the colors you need to see the source text, but =Edit= is disabled. Instead, go to =More= and view the topic in ==raw== format.
       
   105 
       
   106 ---+++ EZ Graphic Icons to Highlight Text
       
   107 
       
   108 Icons can do a lot to enhance scannability of topics. For instance, on *HELP* pages, most people tend to jump around looking for answers rather than reading through - icons help point out the most important bits.
       
   109 
       
   110 TWikiDocGraphics has a whole collection of ready icon images. You can use these images in any topic by referring to their name. For example, !TWikiDocGraphics has an image attachment called =days.gif=. To show this image in a topic, write =%<nop>ICON{"days"}%= to get %ICON{"days"}%.
       
   111 
       
   112 *Creating image variables*
       
   113 
       
   114 You may find it easier to write shorthand graphic notation. You can create your own image variables by defining them in a preference topic (most likely [[%USERSWEB%.%WIKIPREFSTOPIC%]].)
       
   115 
       
   116 A variable name may be one letter, like =Y=, or may be longer like =HELP=, =WARN= etc. You can also add your own images, e.g. a =NEW=, or a =ASK= to ask question.
       
   117 
       
   118 For instance, if we want to write =%<nop>DOWN%= instead of =%<nop>ICON{"arrowbdown"}%=, define the new variable like this:
       
   119 <verbatim>
       
   120    * Set DOWN = %ICON{"arrowbdown"}%
       
   121 </verbatim>
       
   122 Or if you have a custom image to use, attach this to [[%LOCALSITEPREFS%]] and write:
       
   123 <verbatim>
       
   124    * Set DOWN = <img src="%ATTACHURL%/my_image.gif" border="0" alt="DOWN" width="16" height="16" />
       
   125 </verbatim>
       
   126 
       
   127 Most images in TWikiDocGraphics are 16 x 16 pixels.
       
   128 
       
   129    * __Related:__ There are other approaches for creating more extensive TWiki icon libraries. This is a simply and quick way to get started. See TWikiDocGraphics for more info.
       
   130 
       
   131 ---+++ Use TOC variable to create table of content
       
   132 
       
   133 TOC is Table-Of-Content, generated automagically from headers (defined like that: ==---++== , see TWikiShorthand).
       
   134 
       
   135 For example, you may want to put all your custom variables in [[%LOCALSITEPREFS%]] right on top of the page, and generate table of contents, like:
       
   136 
       
   137    * Preferences for easy creating nice pages 
       
   138       * Graphics icons in text 
       
   139       * Colored text 
       
   140    * System Preferences 
       
   141       * Contents of page header and footer 
       
   142       * User interface defaults 
       
   143       * Email 
       
   144       * Plugins 
       
   145       * Notes 
       
   146 
       
   147 Non-admin users wil be interested only in first part, non-system preferences.
       
   148 
       
   149 ---
       
   150 ---++ Personal Productivity - Tools and Tips for Working Faster
       
   151 
       
   152 Although this area applies to all TWiki setups, the initial focus is on TWiki site managers working on a Linux/Apache TWiki site, from a Windows local PC. The assumption being: if you're working with Linux as your desktop, you're probably a programmer or system admin and have these basics handled!
       
   153 
       
   154 ---+++ Use your favorite text editor for major edits
       
   155 
       
   156 When you have a fair bit of TWiki formatting work - for example, compiling new info pages from various cut'n'paste sources, editing multiple TWiki topics or contributed material - it's often easier to use a real *[[TextEditor]]* instead of the browser's text edit box.  There are several methods for doing this.  For Windows, there are several well-recommended text editors.
       
   157 
       
   158 __Windows&nbsp;Example:__ [[http://textpad.com][TextPad]] is a low-cost, top flight Windows program, with an extended trial period. You can download from a well-stocked library of user-contributed macros, dictionaries, and syntax and clip files. You can also easily create a TWiki clip collection that allows you to format text with TWiki code: select a text string and click for bold, italic, links, bullet lists - just like a regular HTML editor - and also insert blocks of TWiki code, use simple or regex search and replace, more.
       
   159 
       
   160 __Copy&nbsp;&amp;&nbsp;Paste:__ Using the web window this can work very well.  System differences may present difficulties with this method but it is simple and reliable in most cases.
       
   161 
       
   162 __Browser&nbsp;Integration:__ Some web browsers can be configured to automatically use an external editor.  See your browser documentation for details.  Such a configuration and a small tool for Linux is described in an example on TWiki.org. TWiki:Codev/EditDaemonWithGVimIntegration
       
   163 
       
   164 __Alternate&nbsp;Browser:__ While your main browser might not have the features for TWiki topic editing, another one might.
       
   165    * An example on the Linux platform is the =w3m= pager/browser for Linux.  This is a text based version similar to =lynx= but it includes text editor features and a configurable command set to act like =lynx= if you are more accustomed to it.
       
   166 
       
   167 ---++ Ready to use SEARCH 
       
   168 
       
   169 ---+++ Personal directory of topics you're involved in
       
   170 
       
   171 Here's how you can create your own personal directory of topics you've contributed to recently. Copy the text below (between *Start Copy* and *End Copy*) and paste it into your personal page (%WIKIUSERNAME%). You can add other webs to search by duplicating one of the web subsections and editing the string {web ="webname"} in the search parameters to refer to the specific web you want to search. This script would also work for a group.
       
   172 
       
   173 *Start Copy*
       
   174 <verbatim>
       
   175 __Here's a list of topics I've been involved in recently:__
       
   176 
       
   177 ---++++ Codev
       
   178 
       
   179 %SEARCH{ "%TOPIC%" web="Codev" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}%
       
   180 ---++++ Support
       
   181 
       
   182 %SEARCH{ "%TOPIC%" web="Support" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}%
       
   183 
       
   184 ---++++ TWiki
       
   185 
       
   186 %SEARCH{ "%TOPIC%" web="TWiki" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="10"}%
       
   187 
       
   188 </verbatim>
       
   189 *End Copy*
       
   190 
       
   191 The SEARCH variable has many more formatting options, see TWikiVariables.
       
   192 
       
   193 ---+++ Recently changed pages 
       
   194 Here are the last 15 changed pages, formatted into a neat table.
       
   195 
       
   196 <verbatim>
       
   197 <table>
       
   198 %SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" nototal="on" order="modified" reverse="on"  format="<tr><td>  [[$topic][$topic]] </td><td>  $wikiusername  </td><td> $date  </td></tr>" limit="15" }%
       
   199 </table>
       
   200 </verbatim>
       
   201 
       
   202 ---
       
   203 ---++ Hidden Edit Lock for Individual Topics
       
   204 
       
   205 When you're creating main gateway pages, you may want to temporarily (or permanently) restrict editing to yourself or a limited group of people. You can do this with a Preference setting that includes one or more users and groups. Only auhorized users will be able to use ==Edit==.
       
   206    * __Example:__ ==Set ALLOWTOPICCHANGE = <nop>%USERSWEB%.UserName, <nop>%USERSWEB%.GroupName==
       
   207    * %T% *To hide the setting:* Use HTML comment tags - put ==&lt;!--== on the line _above the setting, and ==--&gt;== on the line below.
       
   208 
       
   209 ---
       
   210 ---++ Change the Default Logo
       
   211 
       
   212 If you want to change the logo per TWiki web, simply attach a new logo.gif to the web's <nop>WebPreferences, and change the logo's filename by overriding the name using WEBLOGONAME in <nop>WebPreferences:  
       
   213    * =Set WEBLOGONAME = filename.gif=
       
   214 
       
   215 Other cusomtisations are possible using =WEBLOGOIMG=, =WEBLOGOURL=, and =WEBLOGOALT= (they mirror the =WIKILOGO*= TWiki variables, but are applied to each web, rather than to the %<nop>WIKITOOLNAME%-based references)
       
   216 
       
   217 If you'd like to have the same customised logo for all the webs, make these changes in %LOCALSITEPREFS% instead of each web's <nop>WebPreferences, e.g.,
       
   218    * =Set WEBLOGOIMG = %<nop>PUBURLPATH%/%USERSWEB%/WebPreferences/mylogo.gif=
       
   219 
       
   220 ----
       
   221 ---++ Customize Topic Classification Forms
       
   222 
       
   223 With a simple one or two-line default topic form available for every topic  - in *Edit* mode, click the ==[Add]== button, and select the form if it isn't already enabled. Then, click the title to get to the actual form, ==[Edit]==, and carefully change values, probably basic page classifications. You'll get some increased value, and hands-on experience with TWikiForms, without having to read up about them first. %X% __(add the corresponding search per category - copy a default and change)__
       
   224 
       
   225 
       
   226 ---
       
   227 ---++ Add Your Favorite <nop>JavaScript Features
       
   228 
       
   229 You're no doubt familiar or better with HTML, JS, and "webmastering". Without getting into the TWikiTemplates system yet, you can easily edit the ==view.pattern.tmpl== (if you are using default pattern skin) (in the =templates= directory) for some dramatic effects. The top of the template is mostly regular HTML with some variables. Open up some space in the ==&lt;head&gt;== area, and you can drop in reliable <nop>JavaScripts - a pop-up window script, for example - or tag it as an external script.
       
   230 
       
   231    * %T% Obviously, you can do the same - place a link to an external stylesheet as well. If you set values for standard HTML tags, you can control a good deal of the type size, style and color with out adding CSS tags. __example__
       
   232 
       
   233 %X% Depending on what you load up, you may change the overall cross-browser compatibility - however be careful that your site does not look beat up in various other browsers. The scripts you choose will determine compatibility.
       
   234 
       
   235 ---
       
   236 ---++ Customize The Left Navigation Bar
       
   237 
       
   238 Customize the contents of the WebLeftBar for each web to include important topics for that web, or to link to an important topic for the overall site. Each web has its own WebLeftBar page. (This is specific to the PatternSkin.) 
       
   239 
       
   240 ----
       
   241 %T% __NOTE:__ Feel free to add your own tips to TWiki:%WEB%.%TOPIC% as quick notes at the end of the list, following the existing format!
       
   242 
       
   243 __Related Topics:__ AdminDocumentationCategory
       
   244 
       
   245 -- __Contributors:__ TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny, TWiki:Main.MattWilkie, TWiki:Main.AmandaSmith
       
   246 @
       
   247 
       
   248 
       
   249 1.6
       
   250 log
       
   251 @buildrelease
       
   252 @
       
   253 text
       
   254 @d1 1
       
   255 a1 1
       
   256 %META:TOPICINFO{author="TWikiContributor" date="1163619832" format="1.0" version="6"}%
       
   257 d61 1
       
   258 a61 1
       
   259 You may find it easier to write shorthand graphic notation. You can create your own image variables by defining them in a preference topic (most likely [[%MAINWEB%.%WIKIPREFSTOPIC%]].)
       
   260 d153 1
       
   261 a153 1
       
   262    * __Example:__ ==Set ALLOWTOPICCHANGE = <nop>%MAINWEB%.UserName, <nop>%MAINWEB%.GroupName==
       
   263 d165 1
       
   264 a165 1
       
   265    * =Set WEBLOGOIMG = %<nop>PUBURLPATH%/%MAINWEB%/WebPreferences/mylogo.gif=
       
   266 d176 1
       
   267 a176 1
       
   268 You're no doubt familiar or better with HTML, JS, and "webmastering". Without getting into the TWikiTemplates system yet, you can easily edit the ==view.tmpl== (in the =templates= directory) for some dramatic effects. The top of the template is mostly regular HTML with some variables. Open up some space in the ==&lt;head&gt;== area, and you can drop in reliable <nop>JavaScripts - a pop-up window script, for example - or tag it as an external script.
       
   269 @
       
   270 
       
   271 
       
   272 1.5
       
   273 log
       
   274 @buildrelease
       
   275 @
       
   276 text
       
   277 @d1 1
       
   278 a1 1
       
   279 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="5"}%
       
   280 d145 1
       
   281 a145 1
       
   282 %SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on"  format="<tr><td>  [[$topic][$topic]] </td><td>  $wikiusername  </td><td> $date  </td></tr>" limit="15" }%
       
   283 @
       
   284 
       
   285 
       
   286 1.4
       
   287 log
       
   288 @buildrelease
       
   289 @
       
   290 text
       
   291 @d1 1
       
   292 a1 1
       
   293 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="4"}%
       
   294 d29 4
       
   295 a32 4
       
   296 	1 Pick color code from company or product references, the StandardColors table (recommended for 8-bit client compatibility), or some other color reference. 
       
   297 	2 Go to WebPreferences in each web, and edit the topic.
       
   298 	3 Set your preferred WEBBGCOLOR preferences variable, and save the topic.
       
   299 	4 %X% Add a new line immediately after the color code. If there is (invisible) space after the color code, the page header might get strange colors (e.g. black).
       
   300 d46 2
       
   301 a47 2
       
   302 	1 Go to WebPreferences in each web, and edit the topic.
       
   303 	2 In WEBTOPICLIST variable, replace =WebIndex= with =WebTopicList=, and save.
       
   304 d57 1
       
   305 a57 1
       
   306 %TWIKIWEB%.TWikiDocGraphics has a whole collection of ready icon images. You can use these images in any topic by referring to their name. For example, !TWikiDocGraphics has an image attachment called =days.gif=. To show this image in a topic, write =%<nop>ICON{"days"}%= to get %ICON{"days"}%.
       
   307 d67 1
       
   308 a67 1
       
   309 	* Set DOWN = %ICON{"arrowbdown"}%
       
   310 d71 1
       
   311 a71 1
       
   312 	* Set DOWN = <img src="%ATTACHURL%/my_image.gif" border="0" alt="DOWN" width="16" height="16" />
       
   313 d74 1
       
   314 a74 1
       
   315 Most images in %TWIKIWEB%.TWikiDocGraphics are 16 x 16 pixels.
       
   316 d76 1
       
   317 a76 1
       
   318 	* __Related:__ There are other approaches for creating more extensive TWiki icon libraries. This is a simply and quick way to get started. See %TWIKIWEB%.TWikiDocGraphics for more info.
       
   319 d84 9
       
   320 a92 9
       
   321 	* Preferences for easy creating nice pages 
       
   322 		* Graphics icons in text 
       
   323 		* Colored text 
       
   324 	* System Preferences 
       
   325 		* Contents of page header and footer 
       
   326 		* User interface defaults 
       
   327 		* Email 
       
   328 		* Plugins 
       
   329 		* Notes 
       
   330 d112 1
       
   331 a112 1
       
   332 	* An example on the Linux platform is the =w3m= pager/browser for Linux.  This is a text based version similar to =lynx= but it includes text editor features and a configurable command set to act like =lynx= if you are more accustomed to it.
       
   333 d153 2
       
   334 a154 2
       
   335 	* __Example:__ ==Set ALLOWTOPICCHANGE = <nop>%MAINWEB%.UserName, <nop>%MAINWEB%.GroupName==
       
   336 	* %T% *To hide the setting:* Use HTML comment tags - put ==&lt;!--== on the line _above the setting, and ==--&gt;== on the line below.
       
   337 d160 1
       
   338 a160 1
       
   339 	* =Set WEBLOGONAME = filename.gif=
       
   340 d164 2
       
   341 a165 2
       
   342 If you'd like to have the same customised logo for all the webs, make these changes in %TWIKIWEB%.TWikiPreferences instead of each web's <nop>WebPreferences, e.g.,
       
   343 	* =Set WEBLOGOIMG = %<nop>PUBURLPATH%/%TWIKIWEB%/WebPreferences/mylogo.gif=
       
   344 d178 1
       
   345 a178 1
       
   346 	* %T% Obviously, you can do the same - place a link to an external stylesheet as well. If you set values for standard HTML tags, you can control a good deal of the type size, style and color with out adding CSS tags. __example__
       
   347 @
       
   348 
       
   349 
       
   350 1.3
       
   351 log
       
   352 @none
       
   353 @
       
   354 text
       
   355 @d1 1
       
   356 a1 1
       
   357 %META:TOPICINFO{author="PeterThoeny" date="1093211669" format="1.0" version="1.3"}%
       
   358 d4 1
       
   359 a4 1
       
   360 These quick enhancements are aimed at improving TWiki's ease-of-use.  New TWiki site administrators are especially encouraged to review this document for ideas before deploying a new TWikiSite. The metaphor of building a house is useful.  The listed enhancements are some of the details possible when moving into a new office or home. These small changes can make a *big* differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes.  No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics.
       
   361 d8 1
       
   362 a8 1
       
   363 %S% We recommend implementing at least __some__ of these enhancements __right after installation__, to get a taste for what is possible.  Some of these tips and enhancements _should_ be implemented before or during initial roll-out.
       
   364 d10 1
       
   365 a10 1
       
   366 This may spark your imagination to *really* customize your site so that it's optimal for *your* users.  Slightly more advanced customization tips are listed in TWikiAdminCookBook.
       
   367 d15 1
       
   368 a15 1
       
   369 ---++ Tips using TWikiVariables
       
   370 d17 1
       
   371 a17 1
       
   372 You need to know what is the variable name, and in what page is/should be defined.
       
   373 d38 1
       
   374 a38 1
       
   375 Without getting into the TWikiTemplates system yet, you can easily edit the ==view.tmpl== (in the =templates= directory). In the HTML at the top, the body tag has the page background hardcoded to white ==bgcolor="#ffffff"==. You can change that color value to new variable. First, define a new preferences variable in the site-level  TWikiPreferences, e.g. =* Set =PAGEBGCOLOR = #d0d0d0=, then edit the ==view.tmpl== template file and change ==bgcolor="#ffffff"== to ==bgcolor="%<nop>PAGEBGCOLOR%"==. If you want you can set the page background color individualy per web, simple add a =* Set =PAGEBGCOLOR = #d0d0d0= bullet to the WebPreferences to overload the site-level preferences. (Without font color control, you'll have to stick to light colors.
       
   376 d40 1
       
   377 a40 1
       
   378 ---+++ Titles-Only Topic List - WebTopicList
       
   379 d42 1
       
   380 a42 1
       
   381 __A good first navigation tool for new users,__ a fast-loading linked list (page titles only) of a web's topics is a quick and easy way see what's available. By default, slower, but more powerfull WebIndex is used. 
       
   382 d55 1
       
   383 a55 1
       
   384 Graphics in text (like this: %X%) is done also by defining special variables. See [[TWiki.TWikiPreferences]]. Some may prefer longer names, like =HELP=, =WARN= etc. You can also add your own images, e.g. a =NEW=, or a =ASK= to ask question.
       
   385 d57 1
       
   386 a57 1
       
   387 %T% Using graphic icons to highlight important text right from the start can seriously improve how well new users take to a TWiki site. A minimum set of two or three icons can make content much easier to follow, eye-catching, EXCITING. Research says, people tend not to read pages through, but scan them first - and graphics (used sparringly ;-) of course) can help them.  On *HELP* pages, most people tend to jump around looking for answers rather than reading through - icons help point out the most important bits. 
       
   388 d59 1
       
   389 a59 1
       
   390 *How to create your own set of icons:*
       
   391 d61 16
       
   392 a76 6
       
   393 	1 Go to the ==Preferences== topic: TWikiPreferences for site-wide use, or WebPreferences for use in one web only. 
       
   394 	2 ==Attach== a graphic (the ones on this page are 16x16 pixels), then define a Preference Variable with a short but recognizable name.
       
   395 	* __Example:__ Enter =%<nop>TEST%= to get %TEST% - see how it's [[WebPreferences#DefineIcon][done]].
       
   396 	* %T% Ideas for quick icons: NEW; UPDATE; a STAR or other bullet; key symbols relating to your site content.
       
   397 	* For documentation and help, this [[%TWIKIWEB%.%HOMETOPIC%][%TWIKIWEB%]] web uses three main icons: %H% for *HELP*, %T% for *TIP*, %X% for *IMPORTANT*. 
       
   398 	* __Related:__ There are other approaches for creating more extensive TWiki icon libraries. This is a simply and quick way to get started. See TWikiDocGraphics for more info.
       
   399 d82 1
       
   400 a82 1
       
   401 For example, you may want to put all your custom variables in TWikiPreferences right on top of the page, and generate table of contens, like:
       
   402 d99 1
       
   403 a99 1
       
   404 Although this area applies to all TWiki set-ups, the initial focus is on TWiki site managers working on a Linux/Apache TWiki site, from a Windows local PC. The assumption being: if you're working with Linux as your desktop, you're probably a programmer or system admin and have these basics handled!
       
   405 d111 1
       
   406 a111 1
       
   407 __Alternate&nbsp;Browser:__ While your main browser might not have the features for TWikic topic editing, another one might.
       
   408 d141 1
       
   409 a141 1
       
   410 Here, last 15 is formatted into neat table.
       
   411 a154 1
       
   412 	* _This is in the regular help files but worth highlighting._
       
   413 d157 4
       
   414 a160 1
       
   415 ---++ Change the Default Site Logo
       
   416 d162 4
       
   417 a165 2
       
   418 If you want to change the default TWiki logo, attach a new graphic to a topic of choice and change the WIKILOGOIMG variable in the TWikiPreferences, e.g.
       
   419 	* =Set WIKILOGOIMG = %<nop>PUBURL%/%TWIKIWEB%/MyLogo/mylogo.gif=
       
   420 d170 1
       
   421 a170 1
       
   422 With a simple one or two-line default topic form available for every topic  - in *Edit* mode, click the ==[Add]== button, and select the form if it isn't alredy enabled. Then, click the title to get to the actual form, ==[Edit]==, and carefully change values, probably basic page classifications. You'll get some increased value, and hands-on experience with TWikiForms, without having to read up about them first. %X% __(add the corresponding search per category - copy a default and change)__
       
   423 d182 5
       
   424 a187 1
       
   425 
       
   426 d190 1
       
   427 a190 1
       
   428 *Contributors:* TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny, TWiki:Main.MattWilkie
       
   429 d192 1
       
   430 @
       
   431 
       
   432 
       
   433 1.2
       
   434 log
       
   435 @none
       
   436 @
       
   437 text
       
   438 @d1 1
       
   439 a1 1
       
   440 %META:TOPICINFO{author="PeterThoeny" date="1092548024" format="1.0" version="1.2"}%
       
   441 d134 3
       
   442 a136 3
       
   443 &lt;font size="-1">&lt;table>
       
   444  %SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on"  format="&lt;tr>&lt;td>  [[$topic]] &lt;/td>&lt;td>  $wikiusername  &lt;/td>&lt;td> $date  &lt;/td>&lt;/tr>" limit="15" }%
       
   445  &lt;/table>&lt;/font>
       
   446 @
       
   447 
       
   448 
       
   449 1.1
       
   450 log
       
   451 @none
       
   452 @
       
   453 text
       
   454 @d1 173
       
   455 a173 163
       
   456 %META:TOPICINFO{author="PeterThoeny" date="1044003838" format="1.0" version="1.1"}%
       
   457 ---+!! Instant TWiki Site Enhancements
       
   458 
       
   459 These quick enhancements are aimed at improving TWiki's ease-of-use.  New TWiki site administrators are especially encouraged to review this document for ideas before deploying a new TWikiSite. The metaphor of building a house is useful.  The listed enhancedments are some of the details possible when moving into a new office or home. These small changes can make a *big* differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes.  No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics.
       
   460 
       
   461 Many of these tips are based on setting some special TWikiVariables.
       
   462 
       
   463 %S% We recommend implementing at least __some__ of these enhancements __right after installation__, to get a taste for what is possible.  Some of these tips and enhancements _should_ be implemented before or during initial roll-out.
       
   464 
       
   465 This may spark your imagination to *really* customize your site so that it's optimal for *your* users.  Slightly more advanced customization tips are listed in TWikiAdminCookBook.
       
   466 
       
   467 %TOC%
       
   468 
       
   469 ---
       
   470 ---++ Tips using TWikiVariables
       
   471 
       
   472 You need to know what is the variable name, and in what page is/should be defined.
       
   473 
       
   474 ---+++ Change Colors of Page Header/Footer
       
   475 
       
   476 Incredibly obvious, maybe, but some TWiki site admins don't get around to changing the default web colors right off, whether they like them or not. Simply changing the defaults will make a huge difference in the overall look. 
       
   477 
       
   478 *What we are doing*
       
   479 
       
   480 We want to set variable WEBBGCOLOR in topic WebPreferences to one of the StandardColors. <nop>WebPreferences is, as you can guess, a topic which holds all kind of preference setting for each TWiki Web[[ManagingWebs][{*}]]. Each web has its own <nop>WebPreferences, and you can set them differently for each web.
       
   481 
       
   482 *How to do it*
       
   483 
       
   484 	1 Pick color code from company or product references, the StandardColors table (recommended for 8-bit client compatibility), or some other color reference. 
       
   485 	2 Go to WebPreferences in each web, and edit the topic.
       
   486 	3 Set your preferred WEBBGCOLOR preferences variable, and save the topic.
       
   487 	4 %X% Add a new line immediately after the color code. If there is (invisible) space after the color code, the page header might get strange colors (e.g. black).
       
   488 
       
   489 It's just as easy to refine later on, so you're not locked in, just looking better.
       
   490 
       
   491 ---+++ Set Page Background Color 
       
   492 
       
   493 Without getting into the TWikiTemplates system yet, you can easily edit the ==view.tmpl== (in the =templates= directory). In the HTML at the top, the body tag has the page background hardcoded to white ==bgcolor="#ffffff"==. You can change that color value to new variable. First, define a new preferences variable in the site-level  TWikiPreferences, e.g. =* Set =PAGEBGCOLOR = #d0d0d0=, then edit the ==view.tmpl== template file and change ==bgcolor="#ffffff"== to ==bgcolor="%<nop>PAGEBGCOLOR%"==. If you want you can set the page background color individualy per web, simple add a =* Set =PAGEBGCOLOR = #d0d0d0= bullet to the WebPreferences to overload the site-level preferences. (Without font color control, you'll have to stick to light colors.
       
   494 
       
   495 ---+++ Titles-Only Topic List - WebTopicList
       
   496 
       
   497 __A good first navigation tool for new users,__ a fast-loading linked list (page titles only) of a web's topics is a quick and easy way see what's available. By default, slower, but more powerfull WebIndex is used. 
       
   498 
       
   499 Without explaining what WEBTOPICLIST is, just try it: 
       
   500 
       
   501 	1 Go to WebPreferences in each web, and edit the topic.
       
   502 	2 In WEBTOPICLIST variable, replace =WebIndex= with =WebTopicList=, and save.
       
   503 
       
   504 ---+++ Simple way to create %RED% colored text %ENDCOLOR% and graphics
       
   505 
       
   506 This should be enabled, see the "Miscellaneous Settings" in the TWikiPreferences, . If not, look at TWiki:TWiki/TWikiPreferences. Look for variables RED, BLUE etc (which define HTML tag FONT). To copy/paste the variables defining the colors you need to see the source text, but =Edit= is disabled. Instead, go to =More= and view the topic in ==raw== format.
       
   507 
       
   508 ---+++ EZ Graphic Icons to Highlight Text
       
   509 
       
   510 Graphics in text (like this: %X%) is done also by defining special variables. See [[TWiki.TWikiPreferences]]. Some may prefer longer names, like =HELP=, =WARN= etc. You can also add your own images, e.g. a =NEW=, or a =ASK= to ask question.
       
   511 
       
   512 %T% Using graphic icons to highlight important text right from the start can seriously improve how well new users take to a TWiki site. A minimum set of two or three icons can make content much easier to follow, eye-catching, EXCITING. Research says, people tent not to read pages through, but scan them first - and graphics (used sparringly ;-) of course) can help them.  On *HELP* pages, most people tend to jump around looking for answers rather than reading through - icons help point out the most important bits. 
       
   513 
       
   514 *How to create your own set of icons:*
       
   515 
       
   516 	1 Go to the ==Preferences== topic: TWikiPreferences for site-wide use, or WebPreferences for use in one web only. 
       
   517 	2 ==Attach== a graphic (the ones on this page are 16x16 pixels), then define a Preference Variable with a short but recognizable name.
       
   518 	* __Example:__ Enter =%<nop>TEST%= to get %TEST% - see how it's [[WebPreferences#DefineIcon][done]].
       
   519 	* %T% Ideas for quick icons: NEW; UPDATE; a STAR or other bullet; key symbols relating to your site content.
       
   520 	* For documentation and help, this [[%TWIKIWEB%.%HOMETOPIC%][%TWIKIWEB%]] web uses three main icons: %H% for *HELP*, %T% for *TIP*, %X% for *IMPORTANT*. 
       
   521 	* __Related:__ There are other approaches for creating more extensive TWiki icon libraries. This is a simply and quick way to get started. See TWikiDocGraphics for more info.
       
   522 
       
   523 ---+++ Use TOC variable to create table of contens
       
   524 
       
   525 TOC is Table-Of-Contens, generated automagically from headers (defined like that: ==---++== , see TWikiShorthand).
       
   526 
       
   527 For example, you may want to put all your custom variables in TWikiPreferences right on top of the page, and generate table of contens, like:
       
   528 
       
   529 	* Preferences for easy creating nice pages 
       
   530 		* Graphics icons in text 
       
   531 		* Colored text 
       
   532 	* System Preferences 
       
   533 		* Contents of page header and footer 
       
   534 		* User interface defaults 
       
   535 		* Email 
       
   536 		* Plugins 
       
   537 		* Notes 
       
   538 
       
   539 Non-admin users wil be interested only in first part, non-system preferences.
       
   540 
       
   541 ---
       
   542 ---++ Personal Productivity - Tools and Tips for Working Faster
       
   543 
       
   544 Although this area applies to all TWiki set-ups, the initial focus is on TWiki site managers working on a Linux/Apache TWiki site, from a Windows local PC. The assumption being: if you're working with Linux as your desktop, you're probably a programmer or system admin and have these basics handled!
       
   545 
       
   546 ---+++ Use your favorite text editor for major edits
       
   547 
       
   548 When you have a fair bit of TWiki formatting work - for example, compiling new info pages from various cut'n'paste sources, editing multiple TWiki topics or contributed material - it's often easier to use a real *[[TextEditor]]* instead of the browser's text edit box.  There are several methods for doing this.  For Windows, there are several well-recommended text editors.
       
   549 
       
   550 __Windows&nbsp;Example:__ [[http://textpad.com][TextPad]] is a low-cost, top flight Windows program, with an extended trial period. You can download from a well-stocked library of user-contributed macros, dictionaries, and syntax and clip files. You can also easily create a TWiki clip collection that allows you to format text with TWiki code: select a text string and click for bold, italic, links, bullet lists - just like a regular HTML editor - and also insert blocks of TWiki code, use simple or regex search and replace, more.
       
   551 
       
   552 __Copy&nbsp;&amp;&nbsp;Paste:__ Using the web window this can work very well.  System differences may present difficulties with this method but it is simple and reliable in most cases.
       
   553 
       
   554 __Browser&nbsp;Integration:__ Some web browsers can be configured to automatically use an external editor.  See your browser documentation for details.  Such a configuration and a small tool for Linux is described in an example on TWiki.org. TWiki:Codev/EditDaemonWithGVimIntegration
       
   555 
       
   556 __Alternate&nbsp;Browser:__ While your main browser might not have the features for TWikic topic editing, another one might.
       
   557 	* An example on the Linux platform is the =w3m= pager/browser for Linux.  This is a text based version similar to =lynx= but it includes text editor features and a configurable command set to act like =lynx= if you are more accustomed to it.
       
   558 
       
   559 ---+++ Use SEARCH to Create a personal directory of topics you're involved in
       
   560 
       
   561 Here's how you can create your own personal directory of topics you've contributed to recently. Copy the text below (between *Start Copy* and *End Copy*) and paste it into your personal page (%WIKIUSERNAME%). You can add other webs to search by duplicating one of the web subsections and editing the string {web ="webname"} in the search parameters to refer to the specific web you want to search. This script would also work for a group.
       
   562 
       
   563 *Start Copy*
       
   564 <verbatim>
       
   565 __Here's a list of topics I've been involved in recently:__
       
   566 
       
   567 ---++++ Codev
       
   568 
       
   569 %SEARCH{ "%TOPIC%" web="Codev" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" regex="off" order="modified" reverse="on" limit="20"}%
       
   570 
       
   571 ---++++ Support
       
   572 
       
   573 %SEARCH{ "%TOPIC%" web="Support" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" regex="off" order="modified" reverse="on" limit="20"}%
       
   574 
       
   575 ---++++ TWiki
       
   576 
       
   577 %SEARCH{ "%TOPIC%" web="TWiki" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" regex="off" order="modified" reverse="on" limit="10"}%
       
   578 </verbatim>
       
   579 
       
   580 *End Copy*
       
   581 
       
   582 The SEARCH variable has many more formatting options, see TWikiVariables.
       
   583 
       
   584 ---
       
   585 ---++ Hidden Edit Lock for Individual Topics
       
   586 
       
   587 When you're creating main gateway pages, you may want to temporarily (or permanently) restrict editing to yourself or a limited group of people. You can do this with a Preference setting that includes one or more users and groups. Only auhorized users will be able to use ==Edit==.
       
   588 	* __Example:__ ==Set ALLOWTOPICCHANGE = <nop>%MAINWEB%.UserName, <nop>%MAINWEB%.GroupName==
       
   589 	* %T% *To hide the setting:* Use HTML comment tags - put ==&lt;!--== on the line _above the setting, and ==--&gt;== on the line below.
       
   590 	* _This is in the regular help files but worth highlighting._
       
   591 
       
   592 ---
       
   593 ---++ Change the Default Site Logo !! using TWiki:Codev/HighResolutionLogos.
       
   594 
       
   595 Approved and already deployed on several TWiki sites, this logo set provides a professional alternative to the Robot.
       
   596 
       
   597 The size of Robot icon is 46x50 pixels - there are countless 48x48 standard-sized, free-use grapics if you're stuck. Here are some decent places to look. Attach the new graphic to TWikiPreferences, and change the WIKILOGOIMG variable. 
       
   598 
       
   599 ----
       
   600 ---++ Customize Topic Classification Forms
       
   601 
       
   602 With a simple one or two-line default topic form available for every topic  - in *Edit* mode, click the ==[Add]== button, and select the form if it isn't alredy enabled. Then, click the title to get to the actual form, ==[Edit]==, and carefully change values, probably basic page classifications. You'll get some increased value, and hands-on experience with TWikiForms, without having to read up about them first. %X% __(add the corresponding search per category - copy a default and change)__
       
   603 
       
   604 
       
   605 ---
       
   606 ---++ Add Your Favorite <nop>JavaScript Features
       
   607 
       
   608 You're no doubt familiar or better with HTML, JS, and "webmastering". Without getting into the TWikiTemplates system yet, you can easily edit the ==view.tmpl== (in the =templates= directory) for some dramatic effects. The top of the template is mostly regular HTML with some variables. Open up some space in the ==&lt;head&gt;== area, and you can drop in reliable <nop>JavaScripts - a pop-up window script, for example - or tag it as an external script.
       
   609 
       
   610 	* %T% Obviously, you can do the same - place a link to an external stylesheet as well. If you set values for standard HTML tags, you can control a good deal of the type size, style and color with out adding CSS tags. __example__
       
   611 
       
   612 %X% Depending on what you load up, you may change the overall cross-browser compatibility - however be careful that your site does not look beat up in various other browsers. The scripts you choose will determine compatibility.
       
   613 
       
   614 ----
       
   615 
       
   616 %T% __NOTE:__ Feel free to add your own tips to TWiki:%WEB%.%TOPIC% as quick notes at the end of the list, following the existing format!
       
   617 
       
   618 *Contributors:* TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny
       
   619 @