data/TWiki/InstantEnhancements.txt,v
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
head	1.7;
colas@0
     2
access;
colas@0
     3
symbols;
colas@0
     4
locks; strict;
colas@0
     5
comment	@# @;
colas@0
     6
colas@0
     7
colas@0
     8
1.7
colas@0
     9
date	2008.01.22.03.21.29;	author TWikiContributor;	state Exp;
colas@0
    10
branches;
colas@0
    11
next	1.6;
colas@0
    12
colas@0
    13
1.6
colas@0
    14
date	2007.01.16.04.11.57;	author TWikiContributor;	state Exp;
colas@0
    15
branches;
colas@0
    16
next	1.5;
colas@0
    17
colas@0
    18
1.5
colas@0
    19
date	2006.04.01.05.55.07;	author TWikiContributor;	state Exp;
colas@0
    20
branches;
colas@0
    21
next	1.4;
colas@0
    22
colas@0
    23
1.4
colas@0
    24
date	2006.02.01.12.01.17;	author TWikiContributor;	state Exp;
colas@0
    25
branches;
colas@0
    26
next	1.3;
colas@0
    27
colas@0
    28
1.3
colas@0
    29
date	2004.08.22.21.54.31;	author PeterThoeny;	state Exp;
colas@0
    30
branches;
colas@0
    31
next	1.2;
colas@0
    32
colas@0
    33
1.2
colas@0
    34
date	2004.08.15.05.33.44;	author PeterThoeny;	state Exp;
colas@0
    35
branches;
colas@0
    36
next	1.1;
colas@0
    37
colas@0
    38
1.1
colas@0
    39
date	2003.01.31.09.03.58;	author PeterThoeny;	state Exp;
colas@0
    40
branches;
colas@0
    41
next	;
colas@0
    42
colas@0
    43
colas@0
    44
desc
colas@0
    45
@none
colas@0
    46
@
colas@0
    47
colas@0
    48
colas@0
    49
1.7
colas@0
    50
log
colas@0
    51
@buildrelease
colas@0
    52
@
colas@0
    53
text
colas@0
    54
@%META:TOPICINFO{author="TWikiContributor" date="1163619832" format="1.0" version="7"}%
colas@0
    55
---+!! Instant TWiki Site Enhancements
colas@0
    56
colas@0
    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.
colas@0
    58
colas@0
    59
Many of these tips are based on setting some special TWikiVariables.
colas@0
    60
colas@0
    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.
colas@0
    62
colas@0
    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.
colas@0
    64
colas@0
    65
%TOC%
colas@0
    66
colas@0
    67
---
colas@0
    68
---++ Tips using TWiki Variables
colas@0
    69
colas@0
    70
TWikiVariables are a great resource to customize your site. You need to know the variable name and decide where to put it.
colas@0
    71
colas@0
    72
---+++ Change Colors of Page Header/Footer
colas@0
    73
colas@0
    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. 
colas@0
    75
colas@0
    76
*What we are doing*
colas@0
    77
colas@0
    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.
colas@0
    79
colas@0
    80
*How to do it*
colas@0
    81
colas@0
    82
   1 Pick color code from company or product references, the StandardColors table (recommended for 8-bit client compatibility), or some other color reference. 
colas@0
    83
   2 Go to WebPreferences in each web, and edit the topic.
colas@0
    84
   3 Set your preferred WEBBGCOLOR preferences variable, and save the topic.
colas@0
    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).
colas@0
    86
colas@0
    87
It's just as easy to refine later on, so you're not locked in, just looking better.
colas@0
    88
colas@0
    89
---+++ Set Page Background Color 
colas@0
    90
colas@0
    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.)
colas@0
    92
colas@0
    93
---+++ Titles-Only Topic List - !WebTopicList
colas@0
    94
colas@0
    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. 
colas@0
    96
colas@0
    97
Without explaining what WEBTOPICLIST is, just try it: 
colas@0
    98
colas@0
    99
   1 Go to WebPreferences in each web, and edit the topic.
colas@0
   100
   2 In WEBTOPICLIST variable, replace =WebIndex= with =WebTopicList=, and save.
colas@0
   101
colas@0
   102
---+++ Simple way to create %RED% colored text %ENDCOLOR% and graphics
colas@0
   103
colas@0
   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.
colas@0
   105
colas@0
   106
---+++ EZ Graphic Icons to Highlight Text
colas@0
   107
colas@0
   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.
colas@0
   109
colas@0
   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"}%.
colas@0
   111
colas@0
   112
*Creating image variables*
colas@0
   113
colas@0
   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%]].)
colas@0
   115
colas@0
   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.
colas@0
   117
colas@0
   118
For instance, if we want to write =%<nop>DOWN%= instead of =%<nop>ICON{"arrowbdown"}%=, define the new variable like this:
colas@0
   119
<verbatim>
colas@0
   120
   * Set DOWN = %ICON{"arrowbdown"}%
colas@0
   121
</verbatim>
colas@0
   122
Or if you have a custom image to use, attach this to [[%LOCALSITEPREFS%]] and write:
colas@0
   123
<verbatim>
colas@0
   124
   * Set DOWN = <img src="%ATTACHURL%/my_image.gif" border="0" alt="DOWN" width="16" height="16" />
colas@0
   125
</verbatim>
colas@0
   126
colas@0
   127
Most images in TWikiDocGraphics are 16 x 16 pixels.
colas@0
   128
colas@0
   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.
colas@0
   130
colas@0
   131
---+++ Use TOC variable to create table of content
colas@0
   132
colas@0
   133
TOC is Table-Of-Content, generated automagically from headers (defined like that: ==---++== , see TWikiShorthand).
colas@0
   134
colas@0
   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:
colas@0
   136
colas@0
   137
   * Preferences for easy creating nice pages 
colas@0
   138
      * Graphics icons in text 
colas@0
   139
      * Colored text 
colas@0
   140
   * System Preferences 
colas@0
   141
      * Contents of page header and footer 
colas@0
   142
      * User interface defaults 
colas@0
   143
      * Email 
colas@0
   144
      * Plugins 
colas@0
   145
      * Notes 
colas@0
   146
colas@0
   147
Non-admin users wil be interested only in first part, non-system preferences.
colas@0
   148
colas@0
   149
---
colas@0
   150
---++ Personal Productivity - Tools and Tips for Working Faster
colas@0
   151
colas@0
   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!
colas@0
   153
colas@0
   154
---+++ Use your favorite text editor for major edits
colas@0
   155
colas@0
   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.
colas@0
   157
colas@0
   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.
colas@0
   159
colas@0
   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.
colas@0
   161
colas@0
   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
colas@0
   163
colas@0
   164
__Alternate&nbsp;Browser:__ While your main browser might not have the features for TWiki topic editing, another one might.
colas@0
   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.
colas@0
   166
colas@0
   167
---++ Ready to use SEARCH 
colas@0
   168
colas@0
   169
---+++ Personal directory of topics you're involved in
colas@0
   170
colas@0
   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.
colas@0
   172
colas@0
   173
*Start Copy*
colas@0
   174
<verbatim>
colas@0
   175
__Here's a list of topics I've been involved in recently:__
colas@0
   176
colas@0
   177
---++++ Codev
colas@0
   178
colas@0
   179
%SEARCH{ "%TOPIC%" web="Codev" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}%
colas@0
   180
---++++ Support
colas@0
   181
colas@0
   182
%SEARCH{ "%TOPIC%" web="Support" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}%
colas@0
   183
colas@0
   184
---++++ TWiki
colas@0
   185
colas@0
   186
%SEARCH{ "%TOPIC%" web="TWiki" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="10"}%
colas@0
   187
colas@0
   188
</verbatim>
colas@0
   189
*End Copy*
colas@0
   190
colas@0
   191
The SEARCH variable has many more formatting options, see TWikiVariables.
colas@0
   192
colas@0
   193
---+++ Recently changed pages 
colas@0
   194
Here are the last 15 changed pages, formatted into a neat table.
colas@0
   195
colas@0
   196
<verbatim>
colas@0
   197
<table>
colas@0
   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" }%
colas@0
   199
</table>
colas@0
   200
</verbatim>
colas@0
   201
colas@0
   202
---
colas@0
   203
---++ Hidden Edit Lock for Individual Topics
colas@0
   204
colas@0
   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==.
colas@0
   206
   * __Example:__ ==Set ALLOWTOPICCHANGE = <nop>%USERSWEB%.UserName, <nop>%USERSWEB%.GroupName==
colas@0
   207
   * %T% *To hide the setting:* Use HTML comment tags - put ==&lt;!--== on the line _above the setting, and ==--&gt;== on the line below.
colas@0
   208
colas@0
   209
---
colas@0
   210
---++ Change the Default Logo
colas@0
   211
colas@0
   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:  
colas@0
   213
   * =Set WEBLOGONAME = filename.gif=
colas@0
   214
colas@0
   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)
colas@0
   216
colas@0
   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.,
colas@0
   218
   * =Set WEBLOGOIMG = %<nop>PUBURLPATH%/%USERSWEB%/WebPreferences/mylogo.gif=
colas@0
   219
colas@0
   220
----
colas@0
   221
---++ Customize Topic Classification Forms
colas@0
   222
colas@0
   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)__
colas@0
   224
colas@0
   225
colas@0
   226
---
colas@0
   227
---++ Add Your Favorite <nop>JavaScript Features
colas@0
   228
colas@0
   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.
colas@0
   230
colas@0
   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__
colas@0
   232
colas@0
   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.
colas@0
   234
colas@0
   235
---
colas@0
   236
---++ Customize The Left Navigation Bar
colas@0
   237
colas@0
   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.) 
colas@0
   239
colas@0
   240
----
colas@0
   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!
colas@0
   242
colas@0
   243
__Related Topics:__ AdminDocumentationCategory
colas@0
   244
colas@0
   245
-- __Contributors:__ TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny, TWiki:Main.MattWilkie, TWiki:Main.AmandaSmith
colas@0
   246
@
colas@0
   247
colas@0
   248
colas@0
   249
1.6
colas@0
   250
log
colas@0
   251
@buildrelease
colas@0
   252
@
colas@0
   253
text
colas@0
   254
@d1 1
colas@0
   255
a1 1
colas@0
   256
%META:TOPICINFO{author="TWikiContributor" date="1163619832" format="1.0" version="6"}%
colas@0
   257
d61 1
colas@0
   258
a61 1
colas@0
   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%]].)
colas@0
   260
d153 1
colas@0
   261
a153 1
colas@0
   262
   * __Example:__ ==Set ALLOWTOPICCHANGE = <nop>%MAINWEB%.UserName, <nop>%MAINWEB%.GroupName==
colas@0
   263
d165 1
colas@0
   264
a165 1
colas@0
   265
   * =Set WEBLOGOIMG = %<nop>PUBURLPATH%/%MAINWEB%/WebPreferences/mylogo.gif=
colas@0
   266
d176 1
colas@0
   267
a176 1
colas@0
   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.
colas@0
   269
@
colas@0
   270
colas@0
   271
colas@0
   272
1.5
colas@0
   273
log
colas@0
   274
@buildrelease
colas@0
   275
@
colas@0
   276
text
colas@0
   277
@d1 1
colas@0
   278
a1 1
colas@0
   279
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="5"}%
colas@0
   280
d145 1
colas@0
   281
a145 1
colas@0
   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" }%
colas@0
   283
@
colas@0
   284
colas@0
   285
colas@0
   286
1.4
colas@0
   287
log
colas@0
   288
@buildrelease
colas@0
   289
@
colas@0
   290
text
colas@0
   291
@d1 1
colas@0
   292
a1 1
colas@0
   293
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="4"}%
colas@0
   294
d29 4
colas@0
   295
a32 4
colas@0
   296
	1 Pick color code from company or product references, the StandardColors table (recommended for 8-bit client compatibility), or some other color reference. 
colas@0
   297
	2 Go to WebPreferences in each web, and edit the topic.
colas@0
   298
	3 Set your preferred WEBBGCOLOR preferences variable, and save the topic.
colas@0
   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).
colas@0
   300
d46 2
colas@0
   301
a47 2
colas@0
   302
	1 Go to WebPreferences in each web, and edit the topic.
colas@0
   303
	2 In WEBTOPICLIST variable, replace =WebIndex= with =WebTopicList=, and save.
colas@0
   304
d57 1
colas@0
   305
a57 1
colas@0
   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"}%.
colas@0
   307
d67 1
colas@0
   308
a67 1
colas@0
   309
	* Set DOWN = %ICON{"arrowbdown"}%
colas@0
   310
d71 1
colas@0
   311
a71 1
colas@0
   312
	* Set DOWN = <img src="%ATTACHURL%/my_image.gif" border="0" alt="DOWN" width="16" height="16" />
colas@0
   313
d74 1
colas@0
   314
a74 1
colas@0
   315
Most images in %TWIKIWEB%.TWikiDocGraphics are 16 x 16 pixels.
colas@0
   316
d76 1
colas@0
   317
a76 1
colas@0
   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.
colas@0
   319
d84 9
colas@0
   320
a92 9
colas@0
   321
	* Preferences for easy creating nice pages 
colas@0
   322
		* Graphics icons in text 
colas@0
   323
		* Colored text 
colas@0
   324
	* System Preferences 
colas@0
   325
		* Contents of page header and footer 
colas@0
   326
		* User interface defaults 
colas@0
   327
		* Email 
colas@0
   328
		* Plugins 
colas@0
   329
		* Notes 
colas@0
   330
d112 1
colas@0
   331
a112 1
colas@0
   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.
colas@0
   333
d153 2
colas@0
   334
a154 2
colas@0
   335
	* __Example:__ ==Set ALLOWTOPICCHANGE = <nop>%MAINWEB%.UserName, <nop>%MAINWEB%.GroupName==
colas@0
   336
	* %T% *To hide the setting:* Use HTML comment tags - put ==&lt;!--== on the line _above the setting, and ==--&gt;== on the line below.
colas@0
   337
d160 1
colas@0
   338
a160 1
colas@0
   339
	* =Set WEBLOGONAME = filename.gif=
colas@0
   340
d164 2
colas@0
   341
a165 2
colas@0
   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.,
colas@0
   343
	* =Set WEBLOGOIMG = %<nop>PUBURLPATH%/%TWIKIWEB%/WebPreferences/mylogo.gif=
colas@0
   344
d178 1
colas@0
   345
a178 1
colas@0
   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__
colas@0
   347
@
colas@0
   348
colas@0
   349
colas@0
   350
1.3
colas@0
   351
log
colas@0
   352
@none
colas@0
   353
@
colas@0
   354
text
colas@0
   355
@d1 1
colas@0
   356
a1 1
colas@0
   357
%META:TOPICINFO{author="PeterThoeny" date="1093211669" format="1.0" version="1.3"}%
colas@0
   358
d4 1
colas@0
   359
a4 1
colas@0
   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.
colas@0
   361
d8 1
colas@0
   362
a8 1
colas@0
   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.
colas@0
   364
d10 1
colas@0
   365
a10 1
colas@0
   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.
colas@0
   367
d15 1
colas@0
   368
a15 1
colas@0
   369
---++ Tips using TWikiVariables
colas@0
   370
d17 1
colas@0
   371
a17 1
colas@0
   372
You need to know what is the variable name, and in what page is/should be defined.
colas@0
   373
d38 1
colas@0
   374
a38 1
colas@0
   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.
colas@0
   376
d40 1
colas@0
   377
a40 1
colas@0
   378
---+++ Titles-Only Topic List - WebTopicList
colas@0
   379
d42 1
colas@0
   380
a42 1
colas@0
   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. 
colas@0
   382
d55 1
colas@0
   383
a55 1
colas@0
   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.
colas@0
   385
d57 1
colas@0
   386
a57 1
colas@0
   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. 
colas@0
   388
d59 1
colas@0
   389
a59 1
colas@0
   390
*How to create your own set of icons:*
colas@0
   391
d61 16
colas@0
   392
a76 6
colas@0
   393
	1 Go to the ==Preferences== topic: TWikiPreferences for site-wide use, or WebPreferences for use in one web only. 
colas@0
   394
	2 ==Attach== a graphic (the ones on this page are 16x16 pixels), then define a Preference Variable with a short but recognizable name.
colas@0
   395
	* __Example:__ Enter =%<nop>TEST%= to get %TEST% - see how it's [[WebPreferences#DefineIcon][done]].
colas@0
   396
	* %T% Ideas for quick icons: NEW; UPDATE; a STAR or other bullet; key symbols relating to your site content.
colas@0
   397
	* For documentation and help, this [[%TWIKIWEB%.%HOMETOPIC%][%TWIKIWEB%]] web uses three main icons: %H% for *HELP*, %T% for *TIP*, %X% for *IMPORTANT*. 
colas@0
   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.
colas@0
   399
d82 1
colas@0
   400
a82 1
colas@0
   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:
colas@0
   402
d99 1
colas@0
   403
a99 1
colas@0
   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!
colas@0
   405
d111 1
colas@0
   406
a111 1
colas@0
   407
__Alternate&nbsp;Browser:__ While your main browser might not have the features for TWikic topic editing, another one might.
colas@0
   408
d141 1
colas@0
   409
a141 1
colas@0
   410
Here, last 15 is formatted into neat table.
colas@0
   411
a154 1
colas@0
   412
	* _This is in the regular help files but worth highlighting._
colas@0
   413
d157 4
colas@0
   414
a160 1
colas@0
   415
---++ Change the Default Site Logo
colas@0
   416
d162 4
colas@0
   417
a165 2
colas@0
   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.
colas@0
   419
	* =Set WIKILOGOIMG = %<nop>PUBURL%/%TWIKIWEB%/MyLogo/mylogo.gif=
colas@0
   420
d170 1
colas@0
   421
a170 1
colas@0
   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)__
colas@0
   423
d182 5
colas@0
   424
a187 1
colas@0
   425
colas@0
   426
d190 1
colas@0
   427
a190 1
colas@0
   428
*Contributors:* TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny, TWiki:Main.MattWilkie
colas@0
   429
d192 1
colas@0
   430
@
colas@0
   431
colas@0
   432
colas@0
   433
1.2
colas@0
   434
log
colas@0
   435
@none
colas@0
   436
@
colas@0
   437
text
colas@0
   438
@d1 1
colas@0
   439
a1 1
colas@0
   440
%META:TOPICINFO{author="PeterThoeny" date="1092548024" format="1.0" version="1.2"}%
colas@0
   441
d134 3
colas@0
   442
a136 3
colas@0
   443
&lt;font size="-1">&lt;table>
colas@0
   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" }%
colas@0
   445
 &lt;/table>&lt;/font>
colas@0
   446
@
colas@0
   447
colas@0
   448
colas@0
   449
1.1
colas@0
   450
log
colas@0
   451
@none
colas@0
   452
@
colas@0
   453
text
colas@0
   454
@d1 173
colas@0
   455
a173 163
colas@0
   456
%META:TOPICINFO{author="PeterThoeny" date="1044003838" format="1.0" version="1.1"}%
colas@0
   457
---+!! Instant TWiki Site Enhancements
colas@0
   458
colas@0
   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.
colas@0
   460
colas@0
   461
Many of these tips are based on setting some special TWikiVariables.
colas@0
   462
colas@0
   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.
colas@0
   464
colas@0
   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.
colas@0
   466
colas@0
   467
%TOC%
colas@0
   468
colas@0
   469
---
colas@0
   470
---++ Tips using TWikiVariables
colas@0
   471
colas@0
   472
You need to know what is the variable name, and in what page is/should be defined.
colas@0
   473
colas@0
   474
---+++ Change Colors of Page Header/Footer
colas@0
   475
colas@0
   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. 
colas@0
   477
colas@0
   478
*What we are doing*
colas@0
   479
colas@0
   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.
colas@0
   481
colas@0
   482
*How to do it*
colas@0
   483
colas@0
   484
	1 Pick color code from company or product references, the StandardColors table (recommended for 8-bit client compatibility), or some other color reference. 
colas@0
   485
	2 Go to WebPreferences in each web, and edit the topic.
colas@0
   486
	3 Set your preferred WEBBGCOLOR preferences variable, and save the topic.
colas@0
   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).
colas@0
   488
colas@0
   489
It's just as easy to refine later on, so you're not locked in, just looking better.
colas@0
   490
colas@0
   491
---+++ Set Page Background Color 
colas@0
   492
colas@0
   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.
colas@0
   494
colas@0
   495
---+++ Titles-Only Topic List - WebTopicList
colas@0
   496
colas@0
   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. 
colas@0
   498
colas@0
   499
Without explaining what WEBTOPICLIST is, just try it: 
colas@0
   500
colas@0
   501
	1 Go to WebPreferences in each web, and edit the topic.
colas@0
   502
	2 In WEBTOPICLIST variable, replace =WebIndex= with =WebTopicList=, and save.
colas@0
   503
colas@0
   504
---+++ Simple way to create %RED% colored text %ENDCOLOR% and graphics
colas@0
   505
colas@0
   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.
colas@0
   507
colas@0
   508
---+++ EZ Graphic Icons to Highlight Text
colas@0
   509
colas@0
   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.
colas@0
   511
colas@0
   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. 
colas@0
   513
colas@0
   514
*How to create your own set of icons:*
colas@0
   515
colas@0
   516
	1 Go to the ==Preferences== topic: TWikiPreferences for site-wide use, or WebPreferences for use in one web only. 
colas@0
   517
	2 ==Attach== a graphic (the ones on this page are 16x16 pixels), then define a Preference Variable with a short but recognizable name.
colas@0
   518
	* __Example:__ Enter =%<nop>TEST%= to get %TEST% - see how it's [[WebPreferences#DefineIcon][done]].
colas@0
   519
	* %T% Ideas for quick icons: NEW; UPDATE; a STAR or other bullet; key symbols relating to your site content.
colas@0
   520
	* For documentation and help, this [[%TWIKIWEB%.%HOMETOPIC%][%TWIKIWEB%]] web uses three main icons: %H% for *HELP*, %T% for *TIP*, %X% for *IMPORTANT*. 
colas@0
   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.
colas@0
   522
colas@0
   523
---+++ Use TOC variable to create table of contens
colas@0
   524
colas@0
   525
TOC is Table-Of-Contens, generated automagically from headers (defined like that: ==---++== , see TWikiShorthand).
colas@0
   526
colas@0
   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:
colas@0
   528
colas@0
   529
	* Preferences for easy creating nice pages 
colas@0
   530
		* Graphics icons in text 
colas@0
   531
		* Colored text 
colas@0
   532
	* System Preferences 
colas@0
   533
		* Contents of page header and footer 
colas@0
   534
		* User interface defaults 
colas@0
   535
		* Email 
colas@0
   536
		* Plugins 
colas@0
   537
		* Notes 
colas@0
   538
colas@0
   539
Non-admin users wil be interested only in first part, non-system preferences.
colas@0
   540
colas@0
   541
---
colas@0
   542
---++ Personal Productivity - Tools and Tips for Working Faster
colas@0
   543
colas@0
   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!
colas@0
   545
colas@0
   546
---+++ Use your favorite text editor for major edits
colas@0
   547
colas@0
   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.
colas@0
   549
colas@0
   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.
colas@0
   551
colas@0
   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.
colas@0
   553
colas@0
   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
colas@0
   555
colas@0
   556
__Alternate&nbsp;Browser:__ While your main browser might not have the features for TWikic topic editing, another one might.
colas@0
   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.
colas@0
   558
colas@0
   559
---+++ Use SEARCH to Create a personal directory of topics you're involved in
colas@0
   560
colas@0
   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.
colas@0
   562
colas@0
   563
*Start Copy*
colas@0
   564
<verbatim>
colas@0
   565
__Here's a list of topics I've been involved in recently:__
colas@0
   566
colas@0
   567
---++++ Codev
colas@0
   568
colas@0
   569
%SEARCH{ "%TOPIC%" web="Codev" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" regex="off" order="modified" reverse="on" limit="20"}%
colas@0
   570
colas@0
   571
---++++ Support
colas@0
   572
colas@0
   573
%SEARCH{ "%TOPIC%" web="Support" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" regex="off" order="modified" reverse="on" limit="20"}%
colas@0
   574
colas@0
   575
---++++ TWiki
colas@0
   576
colas@0
   577
%SEARCH{ "%TOPIC%" web="TWiki" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" regex="off" order="modified" reverse="on" limit="10"}%
colas@0
   578
</verbatim>
colas@0
   579
colas@0
   580
*End Copy*
colas@0
   581
colas@0
   582
The SEARCH variable has many more formatting options, see TWikiVariables.
colas@0
   583
colas@0
   584
---
colas@0
   585
---++ Hidden Edit Lock for Individual Topics
colas@0
   586
colas@0
   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==.
colas@0
   588
	* __Example:__ ==Set ALLOWTOPICCHANGE = <nop>%MAINWEB%.UserName, <nop>%MAINWEB%.GroupName==
colas@0
   589
	* %T% *To hide the setting:* Use HTML comment tags - put ==&lt;!--== on the line _above the setting, and ==--&gt;== on the line below.
colas@0
   590
	* _This is in the regular help files but worth highlighting._
colas@0
   591
colas@0
   592
---
colas@0
   593
---++ Change the Default Site Logo !! using TWiki:Codev/HighResolutionLogos.
colas@0
   594
colas@0
   595
Approved and already deployed on several TWiki sites, this logo set provides a professional alternative to the Robot.
colas@0
   596
colas@0
   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. 
colas@0
   598
colas@0
   599
----
colas@0
   600
---++ Customize Topic Classification Forms
colas@0
   601
colas@0
   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)__
colas@0
   603
colas@0
   604
colas@0
   605
---
colas@0
   606
---++ Add Your Favorite <nop>JavaScript Features
colas@0
   607
colas@0
   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.
colas@0
   609
colas@0
   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__
colas@0
   611
colas@0
   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.
colas@0
   613
colas@0
   614
----
colas@0
   615
colas@0
   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!
colas@0
   617
colas@0
   618
*Contributors:* TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny
colas@0
   619
@