Difference: PatternSkinCustomization (5 vs. 6)

Revision 62005-10-22 - Main.TWikiContributor

Line: 1 to 1
 

PatternSkin Customization

Line: 6 to 6
 
Changed:
<
<

Logo questions

>
>

First Read: How to modify PatternSkin templates

If you need to change any of the elements that are visible on the common 'view' pages, you need to change the 'view' template: /templates/view.pattern.tmpl. The quickest way would be to simply change the text in the template. A safer way - strongly recommended, because it will survive a TWiki update - is to create your own custom skin. That may sound like an awful lot of work, but in reality a skin may be as much as 1 file that consists of only a few lines of code.

Example
Let's say you want to simplify the bottom toolbar and remove all links except for "More topic actions". You would need to target %TMPL:DEF{"topicactionbuttons"}%, which is located in view.pattern.tmpl.

The steps you would need:

  1. Think up a name for your skin. Let us use myskin for now.
  2. Create a new (empty) view template file in /templates called view.myskin.tmpl.
  3. In view.myskin.tmpl you write:
    %TMPL:INCLUDE{"view"}%
    %TMPL:DEF{"topicactionbuttons"}%%TMPL:P{"activatable_more"}%%TMPL:END%
  4. Now the skin is set. For testing, view any topic and append to the topic name: ?cover=myskin. You should see an effect now.
  5. To make the changes visible on all pages, go to Main.TWikiPreferences (to keep TWikiPreferences intact) and write:
   * Set COVER = myskin
or write
   * Set SKIN = myskin,pattern

Logo

 

How can I change the web logo?

Line: 14 to 38
 The default variables that cause this behavior are defined in TWikiPreferences.

Redefine your custom variables in Main.TWikiPreferences (to keep TWikiPreferences intact):

Changed:
<
<

>
>

 
    • Set WEBLOGONAME = logo.gif
    • Set WEBLOGOIMG = %PUBURLPATH%/%BASEWEB%/%WEBPREFSTOPIC%/%WEBLOGONAME%
    • Set WEBLOGOURL = %SCRIPTURLPATH{"view"}%/%BASEWEB%/%HOMETOPIC%
    • Set WEBLOGOALT = Home
Changed:
<
<
>
>
  There are 2 ways to change the logo in a web:
Line: 27 to 51
 
  • Create a new image named logo.gif and attach it to the web's WebPreferences topic. PatternSkin's stylesheet assumes the logo is 40px high. More about that later.
  • You can also upload the image with FTP to /pub/YourWeb/WebPreferences/.
Added:
>
>
  • Copy the above instructions ("Redefine your custom variables") and insert your logo name.
  Using a new filename:
Line: 34 to 59
 
      * Set WEBLOGONAME = your-logo-name.gif-or-png
Added:
>
>
  • Copy the above instructions ("Redefine your custom variables") and insert your logo name.
 

How do I set a site-wide logo?

There is a bunch of site-wide logo variables in Main.TWikiPreferences: WIKILOGOIMG, WIKILOGOURL and WIKILOGOALT. To change only the web logo image to site-wide, in Main.TWikiPreferences set:

Changed:
<
<

>
>

 
  • Set WEBLOGOIMG = %WIKILOGOIMG%
Changed:
<
<
>
>
 

My logo does not fit the top bar

Line: 52 to 77
 Using templates:
Change the height of the top bar in templates/viewtopbar.pattern.tmpl:
Changed:
<
<
>
>

 %TMPL:DEF{"topbardimensions"}% #patternTopBar, #patternClearHeaderCenter,
Line: 63 to 89
  overflow:hidden; } %TMPL:END%
Changed:
<
<
Only change the number.
>
>

Only change the number from 64px to another value.

 

Using style sheets:

Line: 74 to 101
 

I want to change the white space above and below the logo

Changed:
<
<
Change the table style in WebTopBar. Default top padding is 11px.
>
>
Change the table style in topic WebTopBar. The default top padding is 11px.
 
Changed:
<
<

Top bar questions

>
>

Top bar

 

I want to set or change the top background image

The image at the top is called "header art" - commonly the top image found on blog sites. The image that is displayed by default is set by the variable WEBHEADERART, defined in TWikiPreferences.

Redefine your custom variables in Main.TWikiPreferences (to keep TWikiPreferences intact):

Changed:
<
<

>
>

 
  • Set WEBHEADERART = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/TWiki_header.gif
  • Set WEBHEADERBGCOLOR = somehexcolor (no quotes, for example: #ffffff)
Changed:
<
<
>
>
  You can also set WEBHEADERART per web, by defining the variable in the Web's WebPreferences.

I want to have the web color in the top bar

Redefine WEBHEADERBGCOLOR in Main.TWikiPreferences (to keep TWikiPreferences intact):

Changed:
<
<

>
>

 
  • Set WEBHEADERBGCOLOR = %WEBBGCOLOR%
Changed:
<
<
>
>
 

I want to remove the Jump and Search boxes from the top bar

Line: 106 to 133
 

I want to hide the top bar

Using templates:

Changed:
<
<
The view template is populated like this:
%TMPL:INCLUDE{"page"}%
%TMPL:INCLUDE{"viewtopbar"}%
%TMPL:INCLUDE{"viewtoolbar"}%
%TMPL:INCLUDE{"viewleftbar"}%
%TMPL:INCLUDE{"viewrightbar"}%
%TMPL:INCLUDE{"viewtopicactionbuttons"}%
%TMPL:INCLUDE{"viewbottombar"}%
Each included template draws a part of the screen. Omit %TMPL:INCLUDE{"viewtopbar"}% to hide the top bar, or in a view template clear it using %TMPL:INCLUDE{"viewtopbar"}%%TMPL:END%
>
>
The view template is populated with page elements using template inclusions:

%TMPL:INCLUDE{"page"}%
%TMPL:INCLUDE{"viewtopbar"}%
%TMPL:INCLUDE{"viewtoolbar"}%
%TMPL:INCLUDE{"viewleftbar"}%
%TMPL:INCLUDE{"viewrightbar"}%
%TMPL:INCLUDE{"viewtopicactionbuttons"}%
%TMPL:INCLUDE{"viewbottombar"}%

Each included template draws a part of the screen.
Omit %TMPL:INCLUDE{"viewtopbar"}% to hide the top bar.

Another approach is to clear the contents of module topbar; for example in view.myskin.tmpl:

%TMPL:INCLUDE{"view"}%

%TMPL:INCLUDE{"topbar"}%%TMPL:END%

and add:

%TMPL:DEF{"topbardimensions"}%#patternTopBar,
#patternClearHeaderCenter,
#patternClearHeaderLeft,
#patternClearHeaderRight,
#patternTopBarContentsOuter {
	height:0px;
}%TMPL:END%
 

Using style sheets:

Line: 125 to 174
 See PatternSkinCssCookbookNoTopBar.
Changed:
<
<

Left bar questions

>
>

Left bar

 

I want to hide the left bar

Using templates:

Changed:
<
<
Omit %TMPL:INCLUDE{"viewleftbar"}% to hide the left bar, or in a view template clear it using %TMPL:INCLUDE{"viewleftbar"}%%TMPL:END%
>
>
Omit %TMPL:INCLUDE{"viewleftbar"}% to hide the left bar, or in a view template clear it using %TMPL:DEF{"viewleftbar"}%%TMPL:END%
 

Using style sheets:

Line: 146 to 195
 It may defy the wiki-ness of your TWiki installation, but in certain circumstances it could be useful to hide the edit buttons from users that are not logged in, for instance for customers.

Create in the template directory the file view.customer.tmpl. 'Empty' topicaction and toolbar by writing in the template:

Changed:
<
<
%TMPL:INCLUDE{"view.pattern"}%
%TMPL:DEF{"topicaction"}%%TMPL:END%
%TMPL:DEF{"toolbar"}%%TMPL:END%
>
>
%TMPL:INCLUDE{"view"}%
%TMPL:DEF{"topicaction"}%%TMPL:END%
%TMPL:DEF{"toolbar"}%%TMPL:END%
  In TWikiGuest, set the cover to
Changed:
<
<
   * Set COVER = customer
>
>
   * Set COVER = customer
  By default this topic is editable only by TWikiAdminGroup members.
Added:
>
>

I want to remove the History button from the bottom

All action buttons are defined in viewtopicactionbuttons.pattern.tmpl. Remove module revisions from %TMPL:DEF{"topicactionbuttons"}%.

%TMPL:DEF{"topicactionbuttons"}%%TMPL:P{"activatable_raw_edit"}%%TMPL:P{"sep"}% %TMPL:P{context="WysiwygPluginEnabled" then="activatable_edit_wysiwyg"}%%TMPL:P{context="WysiwygPluginEnabled" then="sep"}% %TMPL:P{"activatable_attach"}%%TMPL:P{"sep"}% %TMPL:P{"printable"}%%TMPL:P{"sep"}% %TMPL:P{"raw"}%%TMPL:P{"sep"}% %TMPL:P{"backlinks"}%%TMPL:P{"sep"}% %TMPL:P{"revisions"}%%TMPL:P{"sep"}% %TMPL:P{"activatable_more"}%%TMPL:END%
In your view.myskin.tmpl file (see above) you write:
%TMPL:INCLUDE{"view"}%

%TMPL:DEF{"topicactionbuttons"}%Edit | 
%TMPL:P{context="WysiwygPluginEnabled" then="activatable_edit_wysiwyg"}% | 
%TMPL:P{"activatable_attach"}% | 
%TMPL:P{"printable"}% | 
%TMPL:P{"raw"}% | 
%TMPL:P{"backlinks"}% | 
%TMPL:P{"activatable_more"}%%TMPL:END%

Remove all newlines if you copy-paste above text.

Test by appending ?cover=myskin to any topic.

I want to insert text outside of the topic content

PatternSkin has 2 'buckets' to write additional content to: beforetextcontents and aftertextcontents, both defined in view.pattern.tmpl. These containers can contain text or html and are placed directly before and after the topic text.

Both modules are wrapped in CSS containers:

  • beforetextcontents - wrapped in div of class twikiBeforeText
  • aftertextcontents - wrapped in div of class twikiAfterText

To put contents before the main text, use the custom skin approach as described above.
So our view.myskin.tmpl file contains:

%TMPL:INCLUDE{"view"}%

%TMPL:DEF{"beforetextcontents"}%This is the text before%TMPL:END%
Test by appending ?cover=myskin to any topic.

Use the same procedure for contents to be put after the topic text:

%TMPL:INCLUDE{"view"}%

 
Added:
>
>
%TMPL:DEF{"aftertextcontents"}%This is the text after%TMPL:END%
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.PatternSkinCustomization