From: Michal Vaner Date: Sat, 30 Aug 2008 12:18:41 +0000 (+0200) Subject: Help works X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=603808d6fe06a611c79e65ba50d46ce2a6b03088;p=pciids.git Help works --- diff --git a/PciIds/Html/Handler.pm b/PciIds/Html/Handler.pm index 4392baf..f490f08 100644 --- a/PciIds/Html/Handler.pm +++ b/PciIds/Html/Handler.pm @@ -39,7 +39,8 @@ my %handlers = ( #Some debug 'test' => \&PciIds::Html::Debug::test, #Notifications - 'notifications' => \&PciIds::Html::Notifications::notifForm + 'notifications' => \&PciIds::Html::Notifications::notifForm, + 'help' => \&PciIds::Html::Help::getHelp }, 'POST' => { 'newitem' => \&PciIds::Html::Changes::newItemSubmit, @@ -59,7 +60,6 @@ sub handler( $$ ) { my( $req, $hasSSL ) = @_; return HTTPRedirect( $req, $req->uri()."index.html" ) if( $req->uri() eq '/' ); return DECLINED if( $req->uri() =~ /^\/((static)\/|robots.txt|index.html)/ ); - return getHelp( $req ) if( $req->uri() =~ /^\/help/ ); my $args = parseArgs( $req->args() ); my $action = $args->{'action'}; $action = '' unless( defined $action ); diff --git a/PciIds/Html/Help.pm b/PciIds/Html/Help.pm index 512f38e..803d922 100644 --- a/PciIds/Html/Help.pm +++ b/PciIds/Html/Help.pm @@ -3,21 +3,28 @@ use strict; use warnings; use PciIds::Startup; use PciIds::Html::Util; +use PciIds::Address; use Apache2::Const qw(:common :http); use base 'Exporter'; our @EXPORT=qw(getHelp); -sub getHelp($) { - my( $req ) = @_; - my( $helpname ) = ( $req->uri() =~ /^\/help\/(.*)/ ); - return NOT_FOUND if( $helpname =~ /[\/.]/ || $helpname eq '' ); +sub getHelp( $$ ) { + my( $req, $args, $tables, $auth ) = @_; + my $helpname = $args->{'help'}; + return NOT_FOUND if( !defined $helpname || $helpname =~ /[\/.]/ || $helpname eq '' ); open HELP, "$directory/help/$helpname" or return NOT_FOUND; my $head = ; chomp $head; genHtmlHead( $req, $head, undef ); - print "

$head

\n"; + my $addr = PciIds::Address::new( $req->uri() ); + print "

$head (".$addr->pretty().")

\n"; + genMenu( $req, $addr, $args, $auth, undef ); + genPath( $req, $addr, 1 ); + my $url = '/read'.$req->uri().buildExcept( 'help', $args ).'?help='; + print "
\n" if( $helpname ne 'index' ); while( defined( my $line = ) ) { + $line =~ s/\$CUR_LINK\$/$url/g; print $line; } close HELP; diff --git a/PciIds/Html/List.pm b/PciIds/Html/List.pm index 875640b..02c62c9 100644 --- a/PciIds/Html/List.pm +++ b/PciIds/Html/List.pm @@ -25,10 +25,10 @@ sub list( $$$$ ) { my $id = $address->pretty(); genHtmlHead( $req, $id, undef ); print '

'.encode( $id ).'

'; - genMenu( $req, $address, $args, $auth ); + genMenu( $req, $address, $args, $auth, 'list' ); + genPath( $req, $address, 0 ); print htmlDiv( 'name', '

'.encode( $name ) ) if( defined( $name ) ); print htmlDiv( 'note', '

'.encode( $note ) ) if( defined( $note ) ); - genPath( $req, $address, 0 ); my $diss = 0; my $history; foreach $history ( @{$tables->history( $address->get() )} ) { @@ -53,7 +53,7 @@ sub list( $$$$ ) { } print "\n" if( $diss ); unless( $address->leaf() ) { - print "

Subitems

\n"; + print "

Sub-items

\n"; my $restricts = $address->defaultRestrictList(); if( scalar @{$restricts} ) { print "

"; diff --git a/PciIds/Html/Notifications.pm b/PciIds/Html/Notifications.pm index 1d5523a..b39bc07 100644 --- a/PciIds/Html/Notifications.pm +++ b/PciIds/Html/Notifications.pm @@ -29,18 +29,18 @@ sub genNotifForm( $$$$$$ ) { } print "\n" if( $started ); print "

\n"; - print "

Effect range

\n"; + print "

Effect range

\n"; print "

{'recursive'} ? " checked='checked'" : "" )."> Recursive\n"; - print "

Notification level

\n"; + print "

Notification level

\n"; print "

\n"; genRadios( [ [ 'None', '3' ], [ 'Main comment & new subitem', '2' ], [ 'Description', '1' ], [ 'Comment', '0' ] ], 'notification', ( defined $data->{'notification'} ) ? $data->{'notification'} : '3' ); - print "

Notification way

\n"; + print "

Notification way

\n"; print "

\n"; genRadios( [ [ 'Email', '0' ], [ 'Xmpp', '1' ], [ 'Both', '2' ] ], 'way', ( defined $data->{'way'} ) ? $data->{'way'} : '0' ); print "

\n"; print "

\n"; if( @{$notifs} ) { - print "

All notifications

    \n"; + print "

    All notifications

      \n"; foreach( @{$notifs} ) { my( $location ) = @{$_}; print "
    • ".PciIds::Address::new( $location )->pretty()."\n"; diff --git a/PciIds/Html/Util.pm b/PciIds/Html/Util.pm index a21d383..02f1a42 100644 --- a/PciIds/Html/Util.pm +++ b/PciIds/Html/Util.pm @@ -34,9 +34,9 @@ sub htmlDiv( $$ ) { return '
      '.$text.'
      '; } -sub item( $$$ ) { - my( $url, $label, $action ) = @_; - print "
    • $label\n"; +sub item( $$ ) { + my( $url, $label ) = @_; + print "
    • $label\n"; } sub genCustomMenu( $$$$ ) { @@ -44,10 +44,12 @@ sub genCustomMenu( $$$$ ) { my $url = '/'.$address->get().buildExcept( 'action', $args ).'?action='; print "
      \n
        \n"; foreach( @{$list} ) { - my( $label, $action ) = @{$_}; + my( $label, $action, $param ) = @{$_}; my $prefix = '/mods'; - $prefix = '/read' if( !defined( $action ) or ( $action eq 'list' ) or ( $action eq '' ) ); - item( 'http://'.$req->hostname().$prefix.$url, $label, $action ); + $prefix = '/read' if( !defined( $action ) or ( $action eq 'list' ) or ( $action eq '' ) or ( $action eq 'help' ) ); + my $suffix = ''; + $suffix = '?help='.$param if( $action eq 'help' ); + item( 'http://'.$req->hostname().$prefix.$url.$action.$suffix, $label ); } print "
      \n"; } @@ -61,14 +63,15 @@ sub logItem( $ ) { } } -sub genMenu( $$$$ ) { - my( $req, $address, $args, $auth ) = @_; +sub genMenu( $$$$$ ) { + my( $req, $address, $args, $auth, $help ) = @_; my @list = ( logItem( $auth ) ); push @list, [ 'Add item', 'newitem' ] if( $address->canAddItem() ); push @list, [ 'Discuss', 'newhistory' ] if( $address->canDiscuss() ); push @list, [ 'Administrate', 'admin' ] if( hasRight( $auth->{'accrights'}, 'validate' ) ); push @list, [ 'Profile', 'profile' ] if defined $auth->{'authid'}; push @list, [ 'Notifications', 'notifications' ] if defined $auth->{'authid'}; + push @list, [ 'Help', 'help', $help ] if defined $help; genCustomMenu( $req, $address, $args, \@list ); } diff --git a/help/list b/help/list new file mode 100644 index 0000000..b09d02c --- /dev/null +++ b/help/list @@ -0,0 +1,48 @@ +Browsing ID list +

      +You can examine the current list of IDs. +The IDs are organized into a tree. +

      Page anatomy

      +

      +Page is divided into parts: +

        +
      • Menu ‒ you can perform actions, both in connection with current item (like adding a new sub-item) and global (editing your profile). +
      • Hierarchy ‒ lists all parental items. +
      • Discussion ‒ contains history of suggested names, notes and general talk about current item. +
      • List of sub-items ‒ all direct sub-items are listed here and you can browse into them. +
      + +You can find menu and hierarchy in most other pages and they have the same function. + +

      Colors

      +Colors are used both in discussion and list of sub-items to mark status of discussion comments and sub-items respectively. +Green entries are discussion comments which provide current item name. +Grey ones are entries with some problem. They are either items without any assigned name (discussion about non-existing item, new item which was not yet approved by an admin) or discussion comments not yet seen by an admin. +White ones are the rest, usual discussion and valid items. + +

      Example

      +
      +

      ID 0000

      +
      +
      +

      ID name

      +

      Discussion

      +
      +

      Name: ID name +

      This item is here just as an example. +

      Author +

      1900-01-01 00:00 +

      +
      +

      Sub-items

      ++
      IdNameNote +
      1234Sub-itemThis is just example +
      +
      diff --git a/static/screen.css b/static/screen.css index aba046a..56018c6 100644 --- a/static/screen.css +++ b/static/screen.css @@ -15,6 +15,11 @@ body { background: #DDFFDD; } +.help-example +{ + background: #BBBBFF; + padding: 0.3em; +} .itemname, .name { font-weight: bold;