Skip to content

Commit

Permalink
Item8047: docu update for natsearch, dependencies fixes to ease insta…
Browse files Browse the repository at this point in the history
…llation

(they are not propagated recursively by the installer, so ...)



git-svn-id: http://svn.foswiki.org/trunk/NatSkin@1994 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
MichaelDaum authored and MichaelDaum committed Jan 15, 2009
1 parent 5d5fc24 commit a37bfa3
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 30 deletions.
28 changes: 12 additions & 16 deletions data/TWiki/NatSearch.txt
@@ -1,30 +1,27 @@
%META:TOPICINFO{author="ProjectContributor" date="1196671408" format="1.1" version="$Rev$"}%
%META:TOPICINFO{author="ProjectContributor" date="1232036349" format="1.1" version="1.2"}%
%META:TOPICPARENT{name="NatSkin"}%
---+!! %TOPIC%
Search facility for the NatSkin.

%TOC%

---++ Description
<nop>NatSearch unifies the Search and the Jump box known from the standard TWiki. It
<nop>NatSearch unifies the Jump &amp; Search boxes known from the standard distribution. It
uses one input field to either jump to a topic or perform a query. You can even
use it as a quick way to create and edit new topic by entering =e:NewTopic= into the input field.

<nop>NatSearch is heavily inspired by the <nop>PhotonSearch of the Foswiki:Extensions/PhotonSkin.
<nop>NatSearch is heavily inspired by the <nop>PhotonSearch by Esteban Manchado Vel�zquez.

---++ Usage
<nop>NatSearch basically works in three modes that are distinguished depending of the input to
the search formfield:
1 if your input starts with an uppercase letter, <nop>NatSearch tries to find the named topic and jumps to it;
you may enter the target topic using the =web.topic= notation
2 if your input starts with an uppercase letter but does not exist as a topic, a topic search tries
to find it; if there is exactly one search hit, <nop>NatSearch jumps to it directly
3 in any other case a combined topic+content search is conducted and its result is displayed in a table,
sorted by modification time, descending
<nop>NatSearch basically first tries to find the named topic and jumps to it if it exists. If not
a combined topic+content search is started. If the topic matches a "web.topic" pattern then
the topic is searched in the given web. If the topic does not exist in this web the following
topic+content search will be conducted in the web. That is, you can search for content in
a given web using a "web.keyword" pattern.

---++ Options
The search string may be prepended with a set of options that are separated from the
The search string may be prefixed with a set of options that are separated from the
rest of the search string with a colon(:). Known options are:

| *Option* | *Description* |
| e(dit) | edit the named topic; note, that this does not perform any search operation |
| n(new) | same as =e= but create a new topic, the named topic must not exist |
Expand All @@ -39,12 +36,11 @@ exclude this term from the hit set.
---++ Examples
| *Search* | *Description* |
| <nop>WikiUsers | if the current web is the %USERSWEB% go to the <nop>WikiUsers |
| | if the current web is the %SYSTEMWEB% go to the <nop>UsersGuide |
| g:WikiUsers | list all topics in all webs whose name match "WikiUsers" |
| g:copyright -webpref | list all topics that contain the word "copyright" but not "webpref" |
| g:"Good morning" -natskin | list all topics that contain the term "Good morning" but not "natskin" |
| e:Sandbox.TestTopic411 | edit <nop>Sandbox.TestTopic411 |
| System.graphics | search for "graphics" in the System web |
| %SYSTEMWEB%.graphics | search for "graphics" in the %SYSTEMWEB% web |


---++ Configuration
Expand All @@ -67,5 +63,5 @@ Besides the NOSEARCHALL feature of every web that excludes a web from search the
| =NATSEARCHTEMPLATE= | configure application-specific search templates topic |

The WebPreferences variable =NATSEARCHTEMPLATE= can be set to a template topic that
is used instead of the skin's =search= template. This can be used in <nop>TWikiApplications to
is used instead of the skin's =search= template. This can be used in <nop>WikiApplications to
define a customized look of search results.
16 changes: 4 additions & 12 deletions data/TWiki/NatSkin.txt
Expand Up @@ -35,16 +35,6 @@ To get a first impression check out the NatSkinStyleBrowser:
* switch on/off navigations tabs above the main area, the so called <nop>WebButtons
* the position of the search box can be set to one of four predefined positions

---++ Acknowledgement
This is a rework of the
Foswiki:Extensions/CopyCatSkin by TWiki:Main/MattWilkie. It is used at the
[[http://nats-www.informatik.uni-hamburg.de/Main/WebHome][Natural Language Systems Division]]
(NATS) of the University of Hamburg, Germany.

The NatSkinPlugin is inspired by the Foswiki:Extensions/GnuSkin by
TWiki:Main/JoachimNilsson. The Foswiki:Extensions/PhotonSkin by
TWiki:Main/EstebanManchado (<nop>PhotonSearch) renamed to =natsearch= .

---++ Feature Overview
*Conditional markup and skin states:*

Expand Down Expand Up @@ -125,15 +115,17 @@ are listed there.
| Skin Author: | Michael Daum |
| Copyright &copy;: | 2003-2009, Michael Daum http://michaeldaumconsulting.com |
| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
| Skin Version: | v3.0-pre36 |
| Skin Version: | v3.0-pre37 |
| Dependencies: | NatSkinPlugin |
| Description: | Driven by cascading stylesheets, Comes with 12 alternative styles, <nop>MoveableType and Wordpress Look-n-Feel |
| Base Name: | nat |
| Screenshot: | <div style="overflow:hidden;height:200px"><a href="%ATTACHURL%/BlueNoteStyle.jpeg"><img src="%ATTACHURL%/BlueNoteStyle.jpeg" title="Clean"/></a></div> |
| Change&nbsp;History: | <!-- specify latest version first -->&nbsp; |
| 15 Jan 2009: | more IE6 workarounds; \
fixed "placing" topics into the Trash web; \
fixed and improved backlinks to topic |
fixed and improved backlinks to topic; \
natsearch docu updates; \
copied the NatSkinPlugin DEPENDENCIES up the food chain to NatSkin |
| 13 Jan 2009: | fixed web topic creator |
| 08 Jan 2009: | fixed the IE6 PNG fix; fixed login screen for IE6 |
| 07 Jan 2009: | added tape-recorder-like history browser; \
Expand Down
2 changes: 1 addition & 1 deletion lib/TWiki/Contrib/NatSkin.pm
@@ -1,6 +1,6 @@
package TWiki::Contrib::NatSkin;
use vars qw($VERSION $RELEASE);
$VERSION = '$Rev$';
$RELEASE = '3.00-pre36';
$RELEASE = '3.00-pre37';

1;
10 changes: 10 additions & 0 deletions lib/TWiki/Contrib/NatSkin/DEPENDENCIES
@@ -1 +1,11 @@
Foswiki::Contrib::FamFamFamContrib,>=1.0,perl,Required.
TWiki::Plugins::BreadCrumbsPlugin,>=1.00,perl,Required
TWiki::Plugins::FamFamFamContrib,>=1.0,perl,Required.
TWiki::Plugins::FilterPlugin,>=1.40,perl,Required
TWiki::Plugins::FlexWebListPlugin,>=1.20,perl,Required
TWiki::Plugins::GluePlugin,>=2.00,perl,Required
TWiki::Plugins::IfDefinedPlugin,>=1.01,perl,Required
TWiki::Plugins::JQueryPlugin,>=1.1,perl,Required
TWiki::Plugins::JQueryTwistyPlugin,>=1.00,perl,Recommended
TWiki::Plugins::NatEditPlugin,>=2.00,perl,Required
TWiki::Plugins::NatSkinPlugin,>=3.0,perl,Required.
2 changes: 1 addition & 1 deletion templates/searchbox.nat.tmpl
@@ -1,6 +1,6 @@
<!-- template: searchbox.nat.tmpl -->
%TMPL:DEF{"searchbox_go"}%<!-- search box go-->
<form name="searchbox" action="%SCRIPTURLPATH{"natsearch"}%/%BASEWEB%/%BASETOPIC%" method="post">
<form name="searchbox" action="%SCRIPTURLPATH{"natsearch"}%/%BASEWEB%/%BASETOPIC%">
<input type="hidden" name="limit" value="100" />
<table cellspacing="0" cellpadding="0" border="0"><tr>
<td valign="middle">
Expand Down

0 comments on commit a37bfa3

Please sign in to comment.