Skip to content

Commit

Permalink
Item12481: added screenshots and docu
Browse files Browse the repository at this point in the history
  • Loading branch information
@MichaelDaum
MichaelDaum committed Jan 14, 2015
1 parent a6c2b39 commit 9e2c41c
Show file tree
Hide file tree
Showing 46 changed files with 271 additions and 135 deletions.
2 changes: 1 addition & 1 deletion data/Main/WebLinks.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
---+ %TOPIC%

Sidebar navigation in the %WEB% web. See also the %SYSTEMWEB%.SiteLinks
Expand Down
2 changes: 1 addition & 1 deletion data/Main/WikiGuestSideBar.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%

%STARTINCLUDE%
%STOPINCLUDE%
Expand Down
2 changes: 1 addition & 1 deletion data/Sandbox/NatSkinTest.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
---+!! %TOPIC%
%BUTTON{"Toggle grid" icon="table" class="foswikiRight" onclick="jQuery('.natMain').toggleClass('showgrid')"}%

Expand Down
2 changes: 1 addition & 1 deletion data/System/EmptySideBarTemplate.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
%META:TOPICPARENT{name="MySideBar"}%
%META:PREFERENCE{name="DENYTOPICVIEW" title="DENYTOPICVIEW" type="Set" value=" "}%
%META:PREFERENCE{name="PERMSET_VIEW" title="PERMSET_VIEW" type="Local" value="everybody"}%
2 changes: 1 addition & 1 deletion data/System/JazzyNoteTheme.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
%META:TOPICPARENT{name="NatSkin"}%
---+!! %TOPIC%

Expand Down
2 changes: 1 addition & 1 deletion data/System/MySideBar.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
%META:TOPICPARENT{name="NatSkin"}%
---+ Create a personalized sidebar navigation
%IF{"$'MYSIDEBAR'='off'"
Expand Down
82 changes: 78 additions & 4 deletions data/System/NatSkin.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
---+!! [[%TOPIC%][The Natural Skin]]

!NatSkin improves your Foswiki experience by bringing together some of the most useful
Expand All @@ -18,6 +18,44 @@ when interacting with wiki content.

---++ Screenshots

<div class="screenshots">
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap1.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap1-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap2.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap2-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap3.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap3-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap4.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap4-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap5.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap5-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap6.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinThemeSnap6-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap2.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap2-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap3.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap3-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap4.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap4-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap5.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap5-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap6.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap6-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap7.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap7-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap8.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap8-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap9.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap9-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap10.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap10-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap11.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap11-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap12.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap12-200.png" /></a>
<a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap13.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap13-200.png" /></a>
</div>

%CLEAR%

<literal>
<style>
.screenshots a {
overflow:hidden;
max-width:190px;
max-height:200px;
float:left;
margin:0 1em 1em 0;
}
.screenshots img {
height:200px;
}
</style>
</literal>

---++ Theme switcher

You can change design and layout aspects of every page as you like with just a few clicks.
Expand Down Expand Up @@ -51,6 +89,7 @@ the templates by using the !NatSkin as a parent skin to create template modifica
* NatSkinConfiguration
* NatSkinFAQ
* NatSkinGrid
* NatSkinTypography
* NatSkinPlugin
---++ Installation Instructions
%$INSTALL_INSTRUCTIONS%
Expand All @@ -65,13 +104,13 @@ the templates by using the !NatSkin as a parent skin to create template modifica
* Set SHORTDESCRIPTION = %$SHORTDESCRIPTION%
-->
| Skin Author: | Michael Daum |
| Copyright &copy;: | 2003-2014, Michael Daum http://michaeldaumconsulting.com |
| Copyright &copy;: | 2003-2015, Michael Daum http://michaeldaumconsulting.com |
| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
| Release: | %$RELEASE% |
| Version: | %$VERSION% |
| Description: | Userfriendly Foswiki skin providing a flexible theming engine for professional webdesigns |
| Base Name: | nat |
| Screenshot: | <div style="overflow:hidden;height:200px"><a href="%PUBURLPATH%/%WEB%/NatSkin/BlueNoteStyle.jpeg"><img src="%PUBURLPATH%/%WEB%/NatSkin/BlueNoteStyle.jpeg" title="JazzyNoteTheme"/></a></div> |
| Screenshot: | <div style="overflow:hidden;height:200px"><a href="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap1.png"><img src="%PUBURLPATH%/%WEB%/NatSkin/NatSkinSnap1-200.png"/></a></div> |
| Change&nbsp;History: | <!-- specify latest version first -->&nbsp; |
| 29 Aug 2013: | third beta |
| 12 Dec 2013: | second beta |
Expand All @@ -80,4 +119,39 @@ the templates by using the !NatSkin as a parent skin to create template modifica
| Home: | Foswiki:Extensions/NatSkin |
| Support: | Foswiki:Support/NatSkin |

%META:FILEATTACHMENT{name="BlueNoteStyle.jpeg" attachment="BlueNoteStyle.jpeg" attr="h" comment="" date="1409560855" path="BlueNoteStyle.jpeg" size="42093" stream="IO::File=GLOB(0x8f2567c)" tmpFilename="/var/tmp/CGItemp41158" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap1.png" attachment="NatSkinSnap1.png" attr="h" comment="" date="1421245043" size="90414" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap1-200.png" attachment="NatSkinSnap1-200.png" attr="ht" comment="" date="1421245043" size="36394" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap2.png" attachment="NatSkinSnap2.png" attr="h" comment="" date="1421245043" size="53315" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap2-200.png" attachment="NatSkinSnap2-200.png" attr="h" comment="" date="1421245043" size="14159" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap10.png" attachment="NatSkinSnap10.png" attr="h" comment="" date="1421245043" size="72803" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap9.png" attachment="NatSkinSnap9.png" attr="h" comment="" date="1421245043" size="39699" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap3.png" attachment="NatSkinSnap3.png" attr="h" comment="" date="1421245043" size="38859" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap4.png" attachment="NatSkinSnap4.png" attr="h" comment="" date="1421245043" size="65346" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap5.png" attachment="NatSkinSnap5.png" attr="h" comment="" date="1421245043" size="110480" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap6.png" attachment="NatSkinSnap6.png" attr="h" comment="" date="1421245043" size="117840" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap7.png" attachment="NatSkinSnap7.png" attr="h" comment="" date="1421245043" size="116892" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap8.png" attachment="NatSkinSnap8.png" attr="h" comment="" date="1421245043" size="67071" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap11.png" attachment="NatSkinSnap11.png" attr="h" comment="" date="1421245043" size="173959" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap4-200.png" attachment="NatSkinSnap4-200.png" attr="h" comment="" date="1421245043" size="23942" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap5-200.png" attachment="NatSkinSnap5-200.png" attr="h" comment="" date="1421245043" size="34327" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap6-200.png" attachment="NatSkinSnap6-200.png" attr="h" comment="" date="1421245043" size="26433" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap7-200.png" attachment="NatSkinSnap7-200.png" attr="h" comment="" date="1421245043" size="26509" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap8-200.png" attachment="NatSkinSnap8-200.png" attr="h" comment="" date="1421245043" size="11870" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap9-200.png" attachment="NatSkinSnap9-200.png" attr="h" comment="" date="1421245043" size="12106" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap10-200.png" attachment="NatSkinSnap10-200.png" attr="h" comment="" date="1421245043" size="9891" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap11-200.png" attachment="NatSkinSnap11-200.png" attr="h" comment="" date="1421245043" size="17800" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap3-200.png" attachment="NatSkinSnap3-200.png" attr="h" comment="" date="1421245043" size="13208" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap12-200.png" attachment="NatSkinSnap12-200.png" attr="h" comment="" date="1421245043" size="27388" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap12.png" attachment="NatSkinSnap12.png" attr="h" comment="" date="1421245043" size="103871" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap13-200.png" attachment="NatSkinSnap13-200.png" attr="h" comment="" date="1421245043" size="14530" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinSnap13.png" attachment="NatSkinSnap13.png" attr="h" comment="" date="1421245043" size="27376" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap2-200.png" attachment="NatSkinThemeSnap2-200.png" attr="h" comment="" date="1421245043" size="44661" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap2.png" attachment="NatSkinThemeSnap2.png" attr="h" comment="" date="1421245043" size="422218" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap3-200.png" attachment="NatSkinThemeSnap3-200.png" attr="h" comment="" date="1421245043" size="35541" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap4-200.png" attachment="NatSkinThemeSnap4-200.png" attr="h" comment="" date="1421245043" size="34134" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap5-200.png" attachment="NatSkinThemeSnap5-200.png" attr="h" comment="" date="1421245043" size="45110" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap5.png" attachment="NatSkinThemeSnap5.png" attr="h" comment="" date="1421245043" size="421865" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap6-200.png" attachment="NatSkinThemeSnap6-200.png" attr="h" comment="" date="1421245043" size="44620" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap6.png" attachment="NatSkinThemeSnap6.png" attr="h" comment="" date="1421245043" size="414253" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap4.png" attachment="NatSkinThemeSnap4.png" attr="h" comment="" date="1421245043" size="135166" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="NatSkinThemeSnap3.png" attachment="NatSkinThemeSnap3.png" attr="h" comment="" date="1421245043" size="126224" user="ProjectContributor" version="1"}%
2 changes: 1 addition & 1 deletion data/System/NatSkinChangeEmailAddressViewTemplate.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
%META:TOPICPARENT{name="NatSkin"}%

%{<verbatim class="tml">}%
Expand Down
2 changes: 1 addition & 1 deletion data/System/NatSkinChangePasswordViewTemplate.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
%META:TOPICPARENT{name="NatSkin"}%

%{<verbatim class="tml">}%
Expand Down
8 changes: 4 additions & 4 deletions data/System/NatSkinConfiguration.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
%META:TOPICPARENT{name="NatSkin"}%
---+!! %TOPIC%
%TOC%
Expand All @@ -23,7 +23,7 @@ This is the list of variables to configure the skin style:

| *Name%BR%(url param)* | *Values* | *Description* | *Default* |
| NATSKIN_STYLE (style) | <noautolink>%KNOWNSTYLES%</noautolink> \
| select a predefined style | jazzynote |
| select a predefined style | customato |
| NATSKIN_VARIATION (skinvariation) | <noautolink>%KNOWNVARIATIONS%</noautolink> \
| select a style variation | none |
| NATSKIN_LAYOUT (skinlayout) | fixed, fluid, bordered \
Expand All @@ -40,11 +40,11 @@ There are a couple of special url parameters:

*Example*:
<verbatim>
* Set NATSKIN_STYLE = jazzynote
* Set NATSKIN_STYLE = customato
* Set NATSKIN_LAYOUT = fixed
* Set NATSKIN_MENU = on
* Set NATSKIN_SIDEBAR = right
* Set NATSKIN_VARIATAION = red
* Set NATSKIN_VARIATAION = frontpage
</verbatim>

---++ Preference variables
Expand Down
43 changes: 27 additions & 16 deletions data/System/NatSkinFAQ.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1409560855" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1421245043" format="1.1" version="1"}%
%META:TOPICPARENT{name="NatSkin"}%
---+!! %TOPIC%
%TOC%
Expand All @@ -14,32 +14,43 @@ If you need help, there are a couple of options:
In any case, helping out improving documentation, fixing bugs, helping others
with the same problems is very welcome.

---++ Why does <nop>NatSkin depend on so many extra plugins?
The main goal is to achieve the best user experience possible. It frankly
does not matter if that requires extra plugins.

Some things can't be done with the inventory being shipped with standard
Foswiki. A lot of the plugins once have been an integral part of the
---++ Why does <nop>NatSkin require on so many extra plugins?
The primary goal is to achieve the best user experience possible and this by using as few extra plugins as possible.
All of the plugins that !NatSkin depends on have been added for a specific purpose.

1 CopyContrib: improve copy-topic feature, such as copy only the attachments, comments, or form data
1 AutoTemplatePlugin: provide NatSkin specific view templates for some of the tools in System web; these are used to implement an improved usability without having to touch the default implementation
1 BreadCrumbsPlugin: an improved way to render the breadcrumbs navigation
1 DBCachePlugin: improved search performance; implements !TopicTitles feature
1 FilterPlugin: filter content as well as format lists in a flexible way
1 FlexWebListPlugin: more flexible way to render the list of installed webs
1 ImagePlugin: server-side image thumbnailing
1 MimeIconPlugin: icon set for all kind of file types used in attachment lists
1 NatSkinPlugin: suplemental plugin, i.e. implements the theme-engine to manage css and templates
1 RenderPlugin: render Foswiki templates using ajax
1 TopicInteractionPlugin: improved attachment handling including batch uploading of images
1 WebLinkPlugin: implements a way to link to a web as well as render its preference settings

A lot of these plugins once have been an integral part of the
NatSkinPlugin and then been externalized into plugins of their own for the
greater benefit.

---++ Why are there so many template files?
<nop>NatSkin does not build upon the standard templates/skin of Foswiki as
it differs substantially in the way it is broken up into components. Therefore,
every function of the core engine will use a =*.nat.tmpl= file. In fact,
the <nop>NatSkin templates are created to provide an independent base
<nop>NatSkin does not build upon the standard templates of Foswiki as
they differ substantially. <nop>NatSkin templates are created to provide an independent base
for further template modifications.

<nop>NatSkin templates offer much more flexibility than the standard
templates do. While its theming engine controls which css files are to
be loaded, it also maintains the =SKIN= path to allow themes to override
the standard markup. So switching a theme does also switch the =SKIN= path
and the templates with it.
templates. While the theming engine controls the css files being loaded,
it also maintains the =SKIN= path to allow themes and their variations to override
the standard markup.

!NatSkin's templates also integrate well into [[Foswiki:Extensions/AngularPlugin][AngularPlugin]] where
pages are loaded asynchronously and patched into an existing skeleton while navigating across topics and webs.

---++ Can I enable offsite link detection?
Yes. Use the ={NatSkin}{DetectExternalLinks}= configuration setting.

---++ Does <nop>NatSkin support <nop>QuietSave?
This feature confuses more than provide any added value and has thus been removed from
the =edit= page to simplify the interface.

0 comments on commit 9e2c41c

Please sign in to comment.