<<O>>  Difference Topic InstantEnhancements (r1.4 - 02 Mar 2006 - DmitryNPopov?)

Instant TWiki Site Enhancements

Changed:
<
<		 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.
>
>		 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.

Many of these tips are based on setting some special TWikiVariables.

PICK 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.

Changed:
<
<		 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.
>
>		 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.

TOC: No TOC in "TWiki.InstantEnhancements"

Line: 18 to 18

Change Colors of Page Header/Footer

Changed:
<
<		 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.
>
>		 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.

What we are doing

Changed:
<
<		 We want to set variable WEBBGCOLOR in topic WebPreferences to one of the StandardColors. WebPreferences is, as you can guess, a topic which holds all kind of preference setting for each TWiki Web{*}. Each web has its own WebPreferences, and you can set them differently for each web.
>
>		 We want to set variable WEBBGCOLOR in topic WebPreferences to one of the StandardColors. WebPreferences is, as you can guess, a topic which holds all kind of preference setting for each TWiki WebManagingWebs?{*}. Each web has its own WebPreferences, and you can set them differently for each web.

How to do it

Line: 31 to 31
  1. Set your preferred WEBBGCOLOR preferences variable, and save the topic.
  2. ALERT! 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).
Changed:
<
<		 It's just as easy to refine later on, so you're not locked in, just looking better.
>
>		 It"s just as easy to refine later on, so you"re not locked in, just looking better.

Set Page Background Color

Changed:
<
<		 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="%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.
>
>		 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="%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.

Titles-Only Topic List - WebTopicList

Changed:
<
<		 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.
>
>		 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.

Without explaining what WEBTOPICLIST is, just try it:

Line: 52 to 52

EZ Graphic Icons to Highlight Text

Changed:
<
<		 Graphics in text (like this: ALERT!) 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.
>
>		 Graphics in text (like this: ALERT!) is done also by defining special variables. See 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.

TIP 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 wink 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.

Line: 60 to 60

  1. Go to the Preferences topic: TWikiPreferences for site-wide use, or WebPreferences for use in one web only.
  2. Attach a graphic (the ones on this page are 16x16 pixels), then define a Preference Variable with a short but recognizable name.
Changed:
<
<
  • Example: Enter %TEST% to get %TEST% - see how it's done.
>
>

  • TIP Ideas for quick icons: NEW; UPDATE; a STAR or other bullet; key symbols relating to your site content.
Changed:
<
<
  • For documentation and help, this TWiki web uses three main icons: HELP for HELP, TIP for TIP, ALERT! for IMPORTANT.
>
>
  • For documentation and help, this WebHomeTWiki? web uses three main icons: HELP for HELP, TIP for TIP, ALERT! for IMPORTANT.

  • 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.

Use TOC variable to create table of content

Line: 86 to 86

Personal Productivity - Tools and Tips for Working Faster

Changed:
<
<		 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!
>
>		 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!

Use your favorite text editor for major edits

Changed:
<
<		 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.
>
>		 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.

Changed:
<
<		 Windows Example: 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.
>
>		 Windows Example: http://textpad.comTextPad 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.

Copy & 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.

Line: 103 to 103

Ready to use SEARCH

Changed:
<
<

Personal directory of topics you're involved in

>
>

Personal directory of topics you"re involved in


Changed:
<
<		 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 (TWikiGuest). 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.
>
>		 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 (TWikiGuest). 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.

Start Copy 





 Changed: 


<
<		

Here's a list of topics I've been involved in recently:



>
>		

Here"s a list of topics I"ve been involved in recently:









  Codev 




Line: 132 to 132








<table>





 Changed: 


<
<		



  TWikiTemplates   MarkCrowley   16 Dec 2009 - 21:00  


  NewUserTemplate   MarkCrowley   16 Dec 2009 - 20:54  


  TWikiRegistration   MarkCrowley   16 Dec 2009 - 20:31  


  WebBottomBar   MarkCrowley   15 Jan 2008 - 22:26  


  WebTopBar   MarkCrowley   06 Jan 2007 - 23:07  


  ResetPassword   MarkCrowley   11 Jul 2006 - 15:09  


  ChangePassword   MarkCrowley   11 Jul 2006 - 15:07  


  LatexModePlugin   MarkCrowley   27 Mar 2006 - 23:58  


  WebHome   MarkCrowley   26 Mar 2006 - 06:54  


  WikiCulture   MarkCrowley   26 Mar 2006 - 06:13  


  TWikiTutorial   MarkCrowley   26 Mar 2006 - 06:12  


  TWikiUserAuthentication   MarkCrowley   26 Mar 2006 - 06:09  


  EditTablePlugin   MarkCrowley   26 Mar 2006 - 06:09  


  GoodStyle   MarkCrowley   26 Mar 2006 - 06:08  


  WebLeftBarCookbook   MarkCrowley   26 Mar 2006 - 06:07  






>
>		



  TWikiTemplatesTWikiTemplates?   MarkCrowley   16 Dec 2009 - 21:00  


  NewUserTemplateNewUserTemplate?   MarkCrowley   16 Dec 2009 - 20:54  


  TWikiRegistrationTWikiRegistration?   MarkCrowley   16 Dec 2009 - 20:31  


  WebBottomBarWebBottomBar?   MarkCrowley   15 Jan 2008 - 22:26  


  WebTopBarWebTopBar?   MarkCrowley   06 Jan 2007 - 23:07  


  ResetPasswordResetPassword?   MarkCrowley   11 Jul 2006 - 15:09  


  ChangePasswordChangePassword?   MarkCrowley   11 Jul 2006 - 15:07  


  LatexModePluginLatexModePlugin?   MarkCrowley   27 Mar 2006 - 23:58  


  WebHomeWebHome?   MarkCrowley   26 Mar 2006 - 06:54  


  WikiCultureWikiCulture?   MarkCrowley   26 Mar 2006 - 06:13  


  TWikiTutorialTWikiTutorial?   MarkCrowley   26 Mar 2006 - 06:12  


  TWikiUserAuthenticationTWikiUserAuthentication?   MarkCrowley   26 Mar 2006 - 06:09  


  EditTablePluginEditTablePlugin?   MarkCrowley   26 Mar 2006 - 06:09  


  GoodStyleGoodStyle?   MarkCrowley   26 Mar 2006 - 06:08  


  WebLeftBarCookbookWebLeftBarCookbook?   MarkCrowley   26 Mar 2006 - 06:07  


















   Hidden Edit Lock for Individual Topics 




 Changed: 


<
<		

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.



>
>		

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.







    

  •  Example: Set ALLOWTOPICCHANGE = Main.UserName, Main.GroupName

    • 

  •  TIP To hide the setting: Use HTML comment tags - put <!-- on the line _above the setting, and --> on the line below.

    • 

  •  This is in the regular help files but worth highlighting.

    • 





Line: 153 to 153








  Customize Topic Classification Forms 




 Changed: 


<
<		

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. ALERT! (add the corresponding search per category - copy a default and change)



>
>		

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. ALERT! (add the corresponding search per category - copy a default and change)













  Add Your Favorite JavaScript Features 




 Changed: 


<
<		

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 <head> area, and you can drop in reliable JavaScripts - a pop-up window script, for example - or tag it as an external script.



>
>		

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 <head> area, and you can drop in reliable JavaScripts - a pop-up window script, for example - or tag it as an external script.









    

  •  TIP 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

    • 






View topic
 | Diffs  | r1.5 | > | r1.4 | > | r1.3
 | More

Revision r1.3 - 22 Aug 2004 - 21:54 - PeterThoeny

Revision r1.4 - 02 Mar 2006 - 13:37 - DmitryNPopov?