Skip to content

Commit

Permalink
Item2653: link fixes, some rewriting to try and clarify, new images t…
Browse files Browse the repository at this point in the history
…hat don't include the t-word

git-svn-id: http://svn.foswiki.org/trunk@7695 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
CrawfordCurrie authored and CrawfordCurrie committed Jun 8, 2010
1 parent 336175d commit a44da83
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 50 deletions.
21 changes: 0 additions & 21 deletions core/data/System/PlainSkin.txt
@@ -1,34 +1,13 @@
%META:TOPICINFO{author="ProjectContributor" date="1231502400" format="1.1" version="$Rev$"}%
%META:TOPICPARENT{name="Skins"}%
---+ Plain Skin

The plain skin is used to get the rendered topic text without any page decoration such as side, top or bottom bars. The text is shown without any markup styles. It can be used to display topic content inside an [[http://www.htmlhelp.com/reference/html40/special/iframe.html][IFRAME]].

This skin is part of every distribution.

This skin has been used to show topics in a pop-up window; this has been replaced with template =viewplain=.


---++ Skin Info

| Description: | Shows rendered topic text without any page decoration |
| Screenshot: | <a href="%ATTACHURL%/fullscreen.gif"><img src="%ATTACHURL%/screenshot.gif" alt="Click for full screen image" width="600" height="130" /></a> |
| Preview: | [[%SCRIPTURL{view}%/%WEB%/%TOPIC%?skin=plain][Preview with this topic]] |
| Base Name: | plain |
| Skin Author: | TWiki:Main.PeterThoeny, Foswiki:Main.CrawfordCurrie |
| Skin Version: | 04 Jan 2006 (v8096) |
| Change History: | <!-- specify latest version first -->&nbsp; |
| 04 Jan 2006: | Dakar update (v8096) |
| 27 Jul 2004: | Initial version (v1.000) |
| Dependencies: | |
| Skin Home: | http://foswiki.org/Extensions/%TOPIC% |
| Feedback: | http://foswiki.org/Extensions/%TOPIC%Dev |
| Appraisal: | http://foswiki.org/Extensions/%TOPIC%Appraisal |

*Note:* The Description, Screenshot and Base Name rows are needed by the %SYSTEMWEB%.SkinBrowser

---
*Related topic:* [[%SYSTEMWEB%.Skins][Skins]], %SYSTEMWEB%.SkinBrowser, %SYSTEMWEB%.UserDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory

%META:FILEATTACHMENT{name="screenshot.gif" attr="h" comment="" date="1090796589" path="screenshot.gif" size="8683" user="ProjectContributor" version="1.1"}%
%META:FILEATTACHMENT{name="fullscreen.gif" attr="h" comment="" date="1090796600" path="fullscreen.gif" size="21130" user="ProjectContributor" version="1.1"}%
19 changes: 1 addition & 18 deletions core/data/System/PrintSkin.txt
@@ -1,31 +1,14 @@
%META:TOPICINFO{author="ProjectContributor" date="1231502400" format="1.1" version="$Rev$"}%
%META:TOPICPARENT{name="Skins"}%
---+ Print Skin

The print skin, useful to print pages with a small header and footer. Other skins, such as PatternSkin, may introduce their own print skin.
The print skin, used for printable pages with a small footer. Other skins, such as PatternSkin, may introduce their own print skin.

This skin is part of every distribution.

---++ Skin Info

| Description: | Useful to print pages with a small header and footer |
| Screenshot: | <a href="%ATTACHURL%/fullscreen.gif"><img src="%ATTACHURL%/screenshot.gif" alt="Click for full screen image" width="600" height="130" /></a> |
| Preview: | [[%SCRIPTURL{view}%/%WEB%/%TOPIC%?skin=print][Preview with this topic]] |
| Base Name: | print |
| Skin Author: | TWiki:Main/PeterThoeny |
| Skin Version: | 04 Jan 2006 (v8096) |
| Change History: | <!-- specify latest version first -->&nbsp; |
| 04 Jan 2006: | Dakar update (v8096) |
| 27 Jul 2004: | Initial version (v1.000) |
| Dependencies: | |
| Skin Home: | http://foswiki.org/Extensions/%TOPIC% |
| Feedback: | http://foswiki.org/Extensions/%TOPIC%Dev |
| Appraisal: | http://foswiki.org/Extensions/%TOPIC%Appraisal |

*Note:* The Description, Screenshot and Base Name rows are needed by the %SYSTEMWEB%.SkinBrowser

---
*Related topic:* [[%SYSTEMWEB%.Skins][Skins]], %SYSTEMWEB%.SkinBrowser, %SYSTEMWEB%.UserDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory

%META:FILEATTACHMENT{name="screenshot.gif" attr="h" comment="" date="1090916727" path="screenshot.gif" size="4040" user="ProjectContributor" version="1.1"}%
%META:FILEATTACHMENT{name="fullscreen.gif" attr="h" comment="" date="1090916872" path="fullscreen.gif" size="12968" user="ProjectContributor" version="1.2"}%
18 changes: 7 additions & 11 deletions core/data/System/Skins.txt
Expand Up @@ -14,29 +14,25 @@ Foswiki ships with a default set of template files that give a very basic, CSS-t

Topic text is not affected by the choice of skin, though a skin can be defined to use a CSS (Cascading Style Sheet), which can sometimes give a radically different appearance to the text.

*Relevant links*
* Foswiki:Support.Extension - Index page for support resources related to skins.
* Foswiki:Extensions.SkinPackage - list of all contributed skin packages

*See other types of extensions:* ContributedAddOns, [[Contribs]], [[Plugins]]

---++ Changing the default skin

%WIKITOOLNAME% by default ships with the skin PatternSkin activated. You can set the skin for the whole site, a single web or topic, or for each user individually, by setting the SKIN setting to the name of a skin. If the skin you select doesn't exist, then %WIKITOOLNAME% will pick up the default templates.

---++ Defining Skins

You may want to define your own skin, for example to comply with corporate web guidelines, or because you have a aesthetic vision that you want to share. There are a couple of places you an start doing this.
You may want to define your own skin, for example to comply with corporate web guidelines, or because you have a aesthetic vision that you want to share. There are a couple of places you can start doing this.

[[Skin templates]] are located by looking at a list of possible locations, including topics and files in the =templates= directory. The lookup process is configurable, and is described in SkinTemplates#FindingTemplates. You can choose to define your skin entirely in topics, entirely in files in =templates=, or in a mixture of both.

The [[skin templates]] used for skins are located in the =templates= directory and are named according to the skin: ==&lt;scriptname&gt;.&lt;skin&gt;.tmpl==. Skin files may also be defined in Foswiki topics - see SkinTemplates for details.
The easiest way to start creating a new skin is to layer it over an existing skin, only overriding those parts of the existing skin that you want to customise. Foswiki can be configured to fall back to another skin if a template is not defined in your skin. A custom skin can be as small as one file!

To start creating a new skin, copy the default skin templates (like =view.tmpl=), or copy an existing skin to use as a base for your own skin. You should only need to copy the files you intend to customise, as Foswiki can be configured to fall back to another skin if a template is not defined in your skin. A custom skin can be as small as one file! Name your files as described above (for example =view.myskin.tmpl=).
Most skins, even those that look radically different to the default, use this layering approach, by basing themselves on the default skin templates (those template files with no skin name e.g =view.tmpl=, =edit.tmpl= etc). These templates provide a minimal interface that is easy to understand and build on. Another advantage of this approach is that if new features are exposed in the default templates, your skin has a chance to pick them up "for free".

If you use PatternSkin as your starting point, and you want to modify the layout, colors or even the templates to suit your own needs, have a look first at the topics PatternSkinCustomization and PatternSkinCssCookbook. These topics also provide practical instructions how to create custom skin template files.

*%X% Note:* Don't call your skin =text= or =rss= as these two skin names have reserved meanings, see below at [[#HardCodedSkins][hard-coded meanings]].

The following template files are used for Foswiki screens, and are referenced in the Foswiki core code. If a skin doesn't define its own version of a template file, then Foswiki will fall back to the next skin in the skin path, or finally, to the default version of the template file.
The following template names are used for Foswiki screens, and are referenced in the Foswiki core code. If a skin doesn't define its own version of a template file, then Foswiki will fall back to the next skin in the skin path, or finally, to the default version of the template file.

(Certain template files are expected to provide certain TMPL:DEFs - these are listed in sub-bullets)
* =addform= - used to select a new form for a topic
Expand Down Expand Up @@ -257,4 +253,4 @@ The =text= skin is reserved for Foswiki internal use.
Skin names starting with =rss= also have a special meaning; if one or more of the skins in the skin path starts with 'rss' then 8-bit characters will be encoded as XML entities in the output, and the =content-type= header will be forced to =text/xml=.

---
*Related Topics:* SkinBrowser, AdminDocumentationCategory, DeveloperDocumentationCategory
*Related Topics:* SkinTemplates, SkinBrowser, AdminDocumentationCategory, DeveloperDocumentationCategory
Binary file modified core/pub/System/PlainSkin/fullscreen.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified core/pub/System/PlainSkin/screenshot.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified core/pub/System/PrintSkin/fullscreen.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified core/pub/System/PrintSkin/screenshot.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a44da83

Please sign in to comment.