Skip to content

Commit

Permalink
Item13274: reworked formatting listies
Browse files Browse the repository at this point in the history
  • Loading branch information
@MichaelDaum
MichaelDaum committed Feb 23, 2015
1 parent 381f12b commit a33a286
Show file tree
Hide file tree
Showing 6 changed files with 219 additions and 205 deletions.
4 changes: 2 additions & 2 deletions lib/Foswiki/Plugins/ListyPlugin.pm
View file
Expand Up @@ -28,8 +28,8 @@ use Foswiki::Func ();
use Foswiki::Plugins ();
use Foswiki::Contrib::JsonRpcContrib ();

our $VERSION = '1.00_001';
our $RELEASE = '1.00_001';
our $VERSION = '1.00_002';
our $RELEASE = '1.00_002';
our $SHORTDESCRIPTION = 'Fancy list manager';
our $NO_PREFS_IN_TOPIC = 1;
our $core;
Expand Down
218 changes: 108 additions & 110 deletions lib/Foswiki/Plugins/ListyPlugin/Core.pm
View file
Expand Up @@ -73,6 +73,16 @@ sub new {
@_
}, $class);

$this->readTemplate();

$this->{format} = Foswiki::Func::expandTemplate("listy::format");
$this->{header} = Foswiki::Func::expandTemplate("listy::header");
$this->{footer} = Foswiki::Func::expandTemplate("listy::footer");
$this->{itemTools} = Foswiki::Func::expandTemplate("listy::item::tools") || '';
$this->{itemFormat}{topic} = Foswiki::Func::expandTemplate("listy::item::topic") || '';
$this->{itemFormat}{external} = Foswiki::Func::expandTemplate("listy::item::external") || '';
$this->{itemFormat}{text} = Foswiki::Func::expandTemplate("listy::item::text") || '';

return $this->init($session);
}

Expand Down Expand Up @@ -115,7 +125,8 @@ sub LISTY {
my $theShowCollections = Foswiki::Func::isTrue($params->{showcollections}, defined($theCollections));
($theWeb, $theTopic) = Foswiki::Func::normalizeWebTopicName($theWeb, $theTopic);
my $theSort = $params->{sort};
$theSort = "index" if !defined($theSort) || $theSort !~ /^(index|title|summary)$/;
$theSort = "index" if !defined($theSort) || $theSort !~ /^(index|title|summary|date)$/;
my $theReverse = Foswiki::Func::isTrue($params->{reverse}, 0);

my $theTypes = $params->{type} || 'text, topic, external';
my %types = map {$_ => 1} split(/\s*,\s*/, $theTypes);
Expand All @@ -127,41 +138,6 @@ sub LISTY {
return ''; # better be silent instead of clutterish
}

my $allowChange = (Foswiki::Func::checkAccessPermission('CHANGE', $wikiName, undef, $theTopic, $theWeb));

$this->readTemplate();

my $itemTools = Foswiki::Func::expandTemplate("listy::item::tools") || '';
$itemTools = '' unless $allowChange;

my $theFormat = $params->{format};
my $defaultFormat = Foswiki::Func::expandTemplate("listy::format");
if (defined $theFormat) {
$theFormat =~ s/\$defaultformat/$defaultFormat/g;
} else {
$theFormat = $defaultFormat;
}
$theFormat =~ s/\$itemtools/$itemTools/g;

my $theHeader = $params->{header};
my $defaultHeader = Foswiki::Func::expandTemplate("listy::header");
if (defined $theHeader) {
$theHeader =~ s/\$defaultheader/$defaultHeader/g;
} else {
$theHeader = $defaultHeader;
}

my $theFooter = $params->{footer};
my $defaultFooter = Foswiki::Func::expandTemplate("listy::footer");
$theFooter = $defaultFooter unless defined $theFooter;
if (defined $theFooter) {
$theFooter =~ s/\$defaultfooter/$defaultFooter/g;
} else {
$theFooter = $defaultFooter;
}

my $theSeparator = $params->{separator} || '$n';

my @listyItems = $this->getListyItems($theWeb, $theTopic);

my %allCollections = ();
Expand All @@ -171,13 +147,20 @@ sub LISTY {

if ($theSort eq 'index') {
@listyItems = sort {$a->{index} <=> $b->{index}} @listyItems;
} elsif ($theSort eq 'date') {
@listyItems = sort {$a->{date} <=> $b->{date}} @listyItems;
} elsif ($theSort eq 'title') {
@listyItems = sort {$a->{title} cmp $b->{title}} @listyItems;
} else {
@listyItems = sort {lc($a->{$theSort}||$a->{topic}||$a->{url}||$a->{title}) cmp lc($b->{$theSort}||$b->{topic})||$b->{url}||$b->{title}} @listyItems;
}

@listyItems = reverse @listyItems if $theReverse;

writeDebug("listy ($theSort): ".join(',', map {$_->{title}} @listyItems));

my $allowChange = (Foswiki::Func::checkAccessPermission('CHANGE', $wikiName, undef, $theTopic, $theWeb));
my $itemTools = $allowChange?$this->{itemTools}:'';

my @results = ();
foreach my $item (@listyItems) {
Expand All @@ -190,39 +173,107 @@ sub LISTY {
}

unless (defined($item->{type})) {
print STDERR "WARNING: mal-formed listy: unknown type in item $item->{name} $theWeb.$theTopic, collection=$collection\n";
print STDERR "WARNING: mal-formed listy: undefined type in item $item->{name} $theWeb.$theTopic, collection=$collection\n";
next;
}

my $line = $theFormat;
my $type = $item->{type};
my $title = $item->{title} || (($type eq 'topic')?getTopicTitle($item->{web}, $item->{topic}):$item->{url}) || '';
$line =~ s/\$item\b/$this->_expandListyItem($item)/ge;
unless ($item->{type} =~ /^(text|topic|external)$/) {
print STDERR "WARNING: mal-formed listy: unknown type '$item->{type}' in item $item->{name} $theWeb.$theTopic, collection=$collection\n";
next;
}

my $title = '';
my $class = 'jqListyItem';
my $summary = $item->{summary} || '';
my $url = '';

my $web = $item->{web} || $this->{baseWeb};
my $topic = $item->{topic} || $this->{baseTopic};
($web, $topic) = Foswiki::Func::normalizeWebTopicName($web, $topic);

if ($item->{type} eq 'topic') {
$title = $item->{title} || getTopicTitle($item->{web}, $item->{topic});
$class .= ' jqListyItemTopic';
$class .= ' foswikiCurrentTopicLink' if $item->{web} && $item->{topic} && $this->{baseWeb} eq $item->{web} && $this->{baseTopic} eq $item->{topic};
$url = Foswiki::Func::getScriptUrlPath($web, $topic, "view");
} elsif ($item->{type} eq 'external') {
$title = $item->{title}||$item->{url};
$class .= ' jqListyItemExternal';
$url = $item->{url} || '';
} else {
$title = $item->{title};
$class .= ' jqListyItemText';
}

my $defaultItemFormat = $this->{itemFormat}{$item->{type}} || '<span class=\'$class\'>$title</span>';
my $itemFormat = $defaultItemFormat;
$itemFormat = $params->{format} if defined $params->{format};
$itemFormat = $params->{$item->{type}."_format"} if defined $params->{$item->{type}."_format"};
$itemFormat = Foswiki::Func::decodeFormatTokens($itemFormat);
$itemFormat = Foswiki::Func::expandCommonVariables($itemFormat, $topic, $web);

my $line = $this->{format};

$line =~ s/\$item\b/$itemFormat/g;
$line =~ s/\$tools\b/$itemTools/g;
$line =~ s/\$class\b/$class/g;
$line =~ s/\$date\b/Foswiki::Func::formatTime($item->{date}/g;
$line =~ s/\$index\b/$item->{index}/g;
$line =~ s/\$url\b/$this->_expandUrl($item)/ge;
$line =~ s/\$type\b/$type/g;
$line =~ s/\$index\b/$item->{index}+1/ge;
$line =~ s/\$url\b/$url/g;
$line =~ s/\$type\b/$item->{type}/g;
$line =~ s/\$title\b/$title/g;
$line =~ s/\$topic\b/($item->{topic}||'')/ge;
$line =~ s/\$web\b/($item->{web}||'')/ge;
$line =~ s/\$topic\b/$topic/g;
$line =~ s/\$web\b/$web/g;
$line =~ s/\$name\b/$item->{name}/g;
$line =~ s/\$summary\b/($item->{summary}||'')/ge;
$line =~ s/\$summary\b/$summary/g;
push @results, $line;
}

if (!scalar(@results)) {
my $count = scalar(@results);

if (!$count) {
return '' if $theHidenull;
push @results, "<!-- -->";
}

my $result = $theHeader.join($theSeparator, @results).$theFooter;
$result =~ s/\$buttons\b/_expandButtons($theWeb, $theTopic, $wikiName)/ge;
$result =~ s/\$count/scalar(@results)/ge;
$result =~ s/\$sourceweb/$theWeb/g;
$result =~ s/\$sourcetopic/$theTopic/g;

my $topButtons = '';
my $bottomButtons = '';
my $buttons = '';
if (!Foswiki::Func::getContext()->{static} && $allowChange) {
$buttons = Foswiki::Func::expandTemplate("listy::buttons");
}
$bottomButtons = $buttons;

if ($params->{buttons}) {
if ($params->{buttons} eq 'top') {
$topButtons = $buttons;
$bottomButtons = '';
} elsif ($params->{buttons} eq 'both') {
$topButtons = $buttons;
}
}

my $style = '';
my $width = $params->{width};
if (defined $width) {
$style = "style='width:$width'";
}

my $class = $params->{class} || '';

my $result = $this->{header}.join("\n", @results).$this->{footer};
$result =~ s/\$buttons\b/$buttons/g;
$result =~ s/\$topbuttons\b/$topButtons/g;
$result =~ s/\$bottombuttons\b/$bottomButtons/g;
$result =~ s/\$sourceweb\b/$theWeb/g;
$result =~ s/\$sourcetopic\b/$theTopic/g;
$result =~ s/\$collection\b/$theCollection/g;
$result =~ s/\$showcollections/$theShowCollections?'true':'false'/ge;
$result =~ s/\$types/$theTypes/g;
$result =~ s/\$showcollections\b/$theShowCollections?'true':'false'/ge;
$result =~ s/\$types\b/$theTypes/g;
$result =~ s/\$count\b/$count/g;
$result =~ s/\$style\b/$style/g;
$result =~ s/\$class\b/$class/g;

my $allCollections = defined($theCollections)?$theCollections:join(",", sort keys %allCollections);
$result =~ s/\$allcollections/$allCollections/g;
Expand Down Expand Up @@ -259,7 +310,8 @@ HERE

$result =~ s/\$encode\((.*?)\)/_entityEncode($1)/ges;
$result =~ s/\$urlEncode\((.*?)\)/_urlEncode($1)/ges;
return Foswiki::Func::decodeFormatTokens($result).$origTml;
$result =~ s/\$tml\b/$origTml/g;
return Foswiki::Func::decodeFormatTokens($result);
}

sub _entityEncode {
Expand Down Expand Up @@ -289,60 +341,6 @@ sub _urlDecode {
return $text;
}

sub _expandButtons {
my ($web, $topic, $wikiName) = @_;

my $buttons = '';

if (!Foswiki::Func::getContext()->{static} && Foswiki::Func::checkAccessPermission('CHANGE', $wikiName, undef, $topic, $web)) {
$buttons = Foswiki::Func::expandTemplate("listy::buttons");
}

return $buttons;
}

sub _expandUrl {
my ($this, $item) = @_;

if ($item->{type} eq 'topic') {
my $web = $item->{web} || $this->{baseWeb};
my $topic = $item->{topic} || $this->{baseTopic};
($web, $topic) = Foswiki::Func::normalizeWebTopicName($web, $topic);
return Foswiki::Func::getScriptUrlPath($web, $topic, "view");
}

if ($item->{type} eq 'external') {
return $item->{url} || '';
}

return '';
}

sub _expandListyItem {
my ($this, $item) = @_;

my $title = '';
my $class = 'jqListyItem';

if ($item->{type} eq 'topic') {
$title = $item->{title} || getTopicTitle($item->{web}, $item->{topic});
$class .= ' jqListyItemTopic';
$class .= ' foswikiCurrentTopicLink' if $item->{web} && $item->{topic} && $this->{baseWeb} eq $item->{web} && $this->{baseTopic} eq $item->{topic};
return "<a href='\$url' class='$class'>$title</a>";
}

if ($item->{type} eq 'external') {
$title = $item->{title}||$item->{url};
$class .= ' jqListyItemExternal';
return "<a href='\$url' class='$class'>$title</a>";
}

$title = $item->{title};
$class .= ' jqListyItemText';

return "<span class='$class'>$title</span>";
}

=begin TML
---++ getListyItems($web, $topic) -> @listyItems
Expand Down
2 changes: 1 addition & 1 deletion pub/System/ListyPlugin/Makefile
View file
@@ -1,4 +1,4 @@
FOSWIKI_ROOT?=~/foswiki/trunk/core
FOSWIKI_ROOT?=~/foswiki/core
TARGET= jquery.listy.js jquery.listy.css

-include $(FOSWIKI_ROOT)/pub/System/JQueryPlugin/Makefile.include
57 changes: 29 additions & 28 deletions pub/System/ListyPlugin/jquery.listy.uncompressed.css
View file
@@ -1,30 +1,44 @@
.jqListy {
.jqListyContainer {
list-style-type:none;
padding:0;
margin:0;
min-height:1.5em;
}
.jqListyContainer > li {
margin:0.5em 0;
position:relative;
display:block;
}
.jqListyButtons {
list-style:none;
margin:0.5em 0;
padding:0;
}
.jqListyContainer .jqListyPlaceholder,
.jqListyContainer .jqListyButtons li {
.jqListy .jqListyPlaceholder,
.jqListy .jqListyButtons li {
background-image:none;
}
.jqListy .jqListyPlaceholder {
min-height:2em;
border:2px dashed #ddd;
border-radius:6px;
margin:0.5em;
margin:0.5em 0;
}

.jqListyItemTools {
display:none;
padding:5px 6px;
margin:-5px -6px -5px 0px;
background-color:#fff;
position:absolute;
right:1px;
top:1px;
z-index:1;
}
.jqListyItemTools a {
display:inline !important;
text-decoration:none;
border:0;
padding:0;
margin:0 0 0 0.5em;
}
.jqListySave,
.jqListyRevert {
Expand All @@ -33,34 +47,21 @@
.jqListyItemTools form {
display:inline;
}
.jqListyItemTools a,
.jqListyItemTools a:hover {
.jqListyItemTools span {
display:inline !important;
margin:0 5px 0 0 !important;
padding:0px !important;
text-decoration:none !important;
}
.jqListySelected {
float:left;

-webkit-box-shadow: 1px 1px 7px rgba(0,0,0, 0.1) !important;
-moz-box-shadow: 1px 1px 7px rgba(0,0,0, 0.1) !important;
box-shadow: 1px 1px 7px rgba(0,0,0, 0.1) !important;

opacity:0.8;
background-color:#efefef;
border-radius:6px;

opacity:0.9;
padding:1em !important;
background-color:#FFF6BF;
border:2px solid #FDD845 !important;
color:#c09853 !important;
}
.jqListySelected .foswikiGrayText,
.jqListySelected .foswikiGrayText a,
.jqListySelected .foswikiGrayText a:hover,
.jqListySelected a,
.jqListySelected a:hover {
color:#c09853 !important;
text-decoration:none;
border:0;
overflow:hidden;
-webkit-box-shadow: 1px 1px 7px rgba(0,0,0, 0.3) !important;
-moz-box-shadow: 1px 1px 7px rgba(0,0,0, 0.3) !important;
box-shadow: 1px 1px 7px rgba(0,0,0, 0.3) !important;
}
.jqListySelected .jqListyItemTools {
display:none !important;
Expand Down

0 comments on commit a33a286

Please sign in to comment.