Fullscreen

Forum: [edu.tw.o] Development Help

Forums > [edu.tw.o] Development > Workspace perms and the 'Workspace Admin'

Workspace perms and the 'Workspace Admin'


posts: 25 3 stars
I've been reflecting on this and I try to analyse it, please point me
out where I am wrong because some of these statements are just
assumptions that I couldn't test, eg. those based on what previous
versions did. I mark these with (?)
After actual verifying, I cut some parts of the original post

There are three workspace related perms:

tiki_p_view_workspace
tiki_p_create_workspace_resour
tiki_p_admin_workspace


All these have to be considered object permissions...
the ones that, once assigned to an object, override any group permissions a user has.

Because, except for admin-god, who anyway doesn't need
...

The workspace itself is an object, with its objectpermissions
Objectperms on a wiki page allow acting on it
Ojectperms on the ws object itself should allow acting on the workspace
But there are differences between what one can do if he has tiki_p_admin_workspace, tiki_p_create_ws_resour as group permission, rather than as objectpermission granted to him.

As group permission these allows managing all aspects of workspaces on every workspace.

The same perms, when granted as objectpermission, do/should do granting him same privileges, but on a single workspace and its childs.

these perms, as object perms, do:

-tiki_p_view_workspace this is self explanatory.

-tiki_p_create_workspace_resour
this allows to create eg. a new wiki page to the workspace
this page will have the permissions copied from the RolePerms of each
role in that workspace type (+ those from/for Anonymous and
Registered groups)
So if RolePerms-teacher? has
tiki_p_view and tiki_p_edit, teacher can view and edit the page.
If RolePerms-student? has only tiki_p_view, the page will grant student
perms to see it but not edit. Same for Anonimous if he has
tiki_p_view, as group though, 'cause he has no RolePerms.
As of aulawiki-1.6.2 it seems that only admin-god can singularily
change these perms (blue key right of resource in resources module)

-tiki_p_admin_workspace
in 1.6.2 this allows
.to add new users/groups to the workspace (?)
.one could also add parent's admin group to it if he knew the
group name (?)
in 1.6.3x it can allow
.add new users/groups to the workspace
.assign objectperms to all other workspace objects, only to the
workspace's predefined roles
.create sub workspaces with their roles and add parent's roles to
it (eg.: become workspace_admin of it)

The Workspace Admin

As you see, tiki_p_admin_workspaces is the key to subcontracting
workspace administration of a specific workspace.
In 1.6.2 it allowed him to add new users to the ws without disturbing
admin-god.
In 1.6.2 he could not admin a child workspace
(delete/create/assign-perms to new resources, add users/groups), unless
a user who had tiki_p_admin_ws on the child added his group to the ws
users/groups (?)
In 1.6.3 it can have more power. If we don't want to give this power
to anyone that has tiki_p_admin_workspace, we need one more perm
(create_child_workspace? admin_child_workspace?). My personal opinion
is not. I think he should be able to admin also all child workspaces: Workspace+Childs Admin

Maybe power to assign object perms for the each ws resource (except for
the workspace itself) can be granted to who has
tiki_p_create_workspace_resour and leave less problems to the Workspace
Admin? (eg student asks to make 'private' or 'public' a page he could just create)

If Workspace Admin = Workspace+Childs Admin, he should be able to grant objectperms to any resource in any of the child workspaces for all the groups in parent and child workspaces

pingus


posts: 25 3 stars
I tested back aulawiki-1.6.2 which should do the same aulawiki-1.5 did

needed actions and possible regrouping into existing/renamed perms
admin single ws: objectperm (create-)admin_ws_resour
     create resour on ws
     change perms on ws resources (except ws object itself)
     add/remove users/groups among this ws type roles only

admin_ws-downwards: objectpem admin_workspace
    create resour on ws-downwards
    change perms on ws object itself
    change perms on resources ws-downwards
    add/remove users/groups ws-downwards

admin all ws: groupperm admin_workspace
    do all on any ws

Table:

1.6.2

perm                    allows as                allows as
name                   groupperm                objectperm
------------------------------------------------------------------------
view_ws                     -                 view the ws
create_resour               -                 create resour onws
admin_ws           do all on any ws           add group/user to ws


1.6.3 proposed

perm                    allows as                allows as
name                   groupperm               objectperm
------------------------------------------------------------------------
view_ws                     -              view the ws
create_resour               -              create resour on ws
(admin resour?)                            change perms on ws resour 
                                             (except ws itself)
                                           add users/groups of
                                             this ws type roles

admin_ws           do all on any ws        add user/group  
                                              ws-down
                                           create resour
                                               ws-down
                                           change perms on
                                               ws-down
                                           change perms on ws
                                               object itself

.


rlopez posts: 32 3 stars
Pingus, may you post the previous table here.
I think it's going to be easier to discuss about the new workspaces and to define a ToDo list there.

It's not very clear for me what you mean with it. I will think on it again.

Thanks wink


posts: 25 3 stars
Yes Roberto, I read about Organic groups and it is very interesting.
I saw also that quite a few bricks have been laid already.
But I am too busy with work outside at the moment to follow this development, and I have the idea there's still quite a bit to be done and it will take some time.
Mine was an attempt to quickly get what I needed basing on 1.6.2.
The table is just way to reconsider the actual 3 permissions of workspaces, making
'tiki_p_create_workspace_resour'
become de facto something like
'tiki_p_admin_workspace_resour' for a single workspace,
and let
'tiki_p_admin_workspace'
be able to create/admin child workspaces (as objectperm, as group perm he would always be able to manage all workspaces)
It was also an occasion to verify if what I evinced through trial and tests was true :-)
I got acquainted with the code by now, and it's nice and clear and most needed functions are already there. And more are in the categories lib, very useful once there's a way to tie workspaces and their groups to categories. It is clear to me now that this was already in the original design.
With respect to 1.6.3, I see an immediate need to find the capability to control the addition of groups (only ws and children's group) for objectperm tiki_p_admin_ws, and allow only adding user to predefined ws groups (no adding new groups) for objectperm tiki_p_create_ws_resour

Xavi told me this can be done at the group level, maybe through user levels?

pingus


rlopez posts: 32 3 stars
> 'tiki_p_admin_workspace_resour' for a single workspace,
I guess you mean for a single workspace resource, right?

> and let
> 'tiki_p_admin_workspace'
> be able to create/admin child workspaces (as objectperm, as group perm he would always be able to manage all workspaces)
This perm enables a hierarchy of workspaces.

I have seen in the last patch (1.6.4) that you added the functions to list all the hierarchy. That's great too.

> I got acquainted with the code by now, and it's nice and clear and most needed functions are already there. And more are in the categories lib, very useful once there's a way to tie workspaces and their groups to categories. It is clear to me now that this was already in the original design.

We will start with the lib of categories to creae this new organic workspaces.

> With respect to 1.6.3, I see an immediate need to find the capability to control the addition of groups (only ws and children's group) for objectperm tiki_p_admin_ws, and allow only adding user to predefined ws groups (no adding new groups) for objectperm tiki_p_create_ws_resour
>
> Xavi told me this can be done at the group level, maybe through user levels?
>
Sure. If you create user levels then you are able to administer permissions independently for each of them.
> pingus



rlopez posts: 32 3 stars
>...
> In 1.6.3 it can have more power. If we don't want to give this power
> to anyone that has tiki_p_admin_workspace, we need one more perm
> (create_child_workspace? admin_child_workspace?). My personal opinion
> is not. I think he should be able to admin also all child workspaces: Workspace+Childs Admin

First things first. A good starting point for this new permissions hierarchy on workspaces should be not to add this new admin_child_workspace. Moreover, it has sense that you can manage all your child workspaces. We could think on a more sophisticated permissions hierarchy later.

>
> Maybe power to assign object perms for the each ws resource (except for
> the workspace itself) can be granted to who has
> tiki_p_create_workspace_resour and leave less problems to the Workspace
> Admin? (eg student asks to make 'private' or 'public' a page he could just create)
>

Sure, I agree again biggrin. This is an interesting point. Thinking on a student/employee that is the manager of a work group. He can't create the whole workspace but he can admin the resources. Less work for admin wink

> If Workspace Admin = Workspace+Childs Admin, he should be able to grant objectperms to any resource in any of the child workspaces for all the groups in parent and child workspaces
>

I agree again.

Pingus. something we must consider is what mpvolt has suggested for perspectives:Organic groups.
Might it be the way users/admin manage workspaces?

I mean, what you are pointing is to go further with a permission systems that could be managed by organic workspaces, i.e. a workspace that can be born, grow and die without requiring the involvement of an administrator.

We are considering this in the new perspectives stuff.

Good work pingus. Let's continue. biggrin


posts: 25 3 stars
Latest note to patches posted here:
http://dev.tikiwiki.org/tiki-view_tracker_item.php?itemId=2297&trackerId=5

  • Versions 1.6.2x are intended just to make aulawiki work on TikiWiki
2.2, the way it worked before.
  • Versions 1.6.3x is a transition step.
  • Versions 1.6.4x is a new development intended to give a RolePerm? with
tiki_p_admin_workspace the capability to create new child workspaces. It
though limits him to adding only 'users' to the workspace, not groups.
For global tiki_p_admin_workspace nothing changes though.
  • Versions 1.6.5x will put back capability to add groups to the
workspace (not only users), and see all child's groups when adding perms to single workspace resources.
This will be done by adding some new functions to workspaceslib.php:

- get_child_workspaces_groups : will gel all groups in WS and child
workspaces. DONE
-get_topmost_workspace_IAdmin or get_my_topmost_workspace : will get up in the workspace path and get the topmost one on which I have
tiki_p_admin_workspace

with these functions a RolePerm? with tiki_p_admin_workspace will have
complete view of all child workspaces and their groups down from the
topmost one he can admin, no matter in which of these he is actually
(current workspace), and be able to add groups and assign perms to
groups within all these ones (only) without need of of having tiki_p_admin_workspaces on any child ws


rlopez posts: 32 3 stars
Nice work pingus!

We will upload to the experimental branch the version 1.6.4.

Thanks!


Show posts:
Jump to forum:

For more information, please see Wiki Page Editor & Wiki Syntax

Wiki Syntax
Bold text     __text__
Italic text     2 single quotes (').     ''text''
Underlined text     ===text===
Colored text
~~#FFEE33:text~~ or ~~yellow:text~~. Will display using the indicated HTML color or color name. Color name can contain two colors separated by a comma. In this case, the first color would be the foreground and the second one the background.
Deleted text     2 dashes "-".     --text--
Headings
!heading1, !!heading2, !!!heading3
Show/Hide
!+, !!- show/hide heading section. + (shown) or - (hidden) by default.
Autonumbered Headings
!#, !!#, !+#, !-# ...
Table of contents
{toc}, {maketoc} prints out a table of contents for the current page based on structures (toc) or ! headings (maketoc)
Horizontal rule     ----
Text box     ^Box content^
Centered text     ::text::
Dynamic variables
%Name% Inserts an editable variable
External links
use square brackets for an external link: [URL], [URL|link_description],[URL|link_description|relation] or [URL|description|relation|nocache] (that last prevents the local Wiki from caching the linked page; relation can be used to insert rel attribute for the link - useful e.g. for shadowbox).
For an external Wiki, use ExternalWikiName:PageName or ((External Wiki Name: Page Name))
Square Brackets
Use [[foo] to show [foo].
Wiki References
JoinCapitalizedWords or use ((page)) or ((page|description)) for wiki references , ))SomeName(( prevents referencing
Lists
* for bullet lists, # for numbered lists, ;Word:definition for definiton lists
Indentation
+, ++ Creates an indentation for each plus (useful in list to continue at the same level)
Tables
||row1-col1|row1-col2|row1-col3
row2-col1|row2-col2|row2-col3||
Title bar     -=Title=-
Monospace font     -+Code sample+-
Line break
%%% (very useful especially in tables)
Drawings
{draw name=foo} creates the editable drawing foo
Multi-page pages
Use ...page... to separate pages
Non parsed sections
~np~ data ~/np~ Prevents wiki parsing of the enclosed data.
Preformated sections
~pp~ data ~/pp~ Displays preformated text/code; no Wiki processing is done inside these sections (as with np), and the spacing is fixed (no word wrapping is done). ~pre~ data ~/pre~ also displayes preformatted text with fixed spacing, but wiki processing still occurs on the text.
Comments
~tc~ Tiki Comment ~/tc~ makes a Tiki comment. It will be completely removed from the display, but saved in the file for future reference. ~hc~ HTML Comment ~/hc~ makes an HTML comment. It will be inserted as a comment in the output HTML; these are not normally displayed in browsers, but can be seen using "View Source" or similar.
Block Preformatting
Indent text with any number of spaces to turn it into a monospaced block that still follows other Wiki formatting instructions. It will be indended with the same number of spaces that you used. Note that this mode does not preserve exact spacing and line breaks; use ~pp~...~/pp~ for that.
Direction
{r2l}, {l2r}, {rm}, {lm}Insert resp. right-to-left and left-to-right text direction DIV (up to end of text) and markers for langages as arabic or hebrew.
Special characters
~hs~ hard space, ~c~ ©, ~amp~ &, ~lt~ <, ~gt~ >, ~ldq~ “, ~rdq~ ”, ~lsq~ ‘, ~rsq~ ’, ~--~ —, ~bs~ \, numeric between ~ for html numeric characters entity

Because the Wiki paragraph formatting feature is off, each line will be presented as you write it. This means that if you want paragraphs to be wrapped properly, a paragraph should be all together on one line.

Plugins Help

Note that plugin arguments can be enclosed with double quotes ("); this allows them to contain , or = or >.


Description
Attachment Help
Displays an attachment or a list of them
{ATTACH(
[ name="Gives the name of the attached file to link to" ]
[ file="Same as name" ]
[ page="Gives the name of another page the attached file is on. The file on that page is linked to instead. Only works with wiki pages" ]
[ showdesc="Shows the description as the link text instead of the file name" ]
[ bullets="Makes the list of attachments a bulleted list" ]
[ image="Says that this file is an image, and should be displayed inline using the img tag" ]
[ inline="Puts the stuff between {ATTACH} tags as the link text instead of the file name or description" ]
[ all="Shows all attachments from the whole wiki" ]
[ num="Gives the number, in the list of attachments, of the attachment to link to" ]
[ id="Gives the actual id of the attachment to link in. You probably should never use this" ]
[ dls="Puts the number of downloads in the alt comment" ]
[ icon="Shows a file icon" ]
)}
Comment
{ATTACH}
Box Help
Insert theme styled box on wiki page
{BOX(
[ title="Displayed above the content" ]
[ bg="As defined by CSS, name or Hex code." ]
[ width="In pixels or percentage. Default value is 100%." ]
[ align="left|right|center" ]
[ float="left|right, for box with width lesser than 100%, make text wrap around the box." ]
[ class="Apply custom CSS class to the box." ]
)}
text
{BOX}
Category Help
Insert list of items for the current/given category into wiki page
{category
[ id="List of category IDs separated by + signs. ex: 1+2+3. Default will use category of the current page." ]
[ types="List of object types to include in the list separated by plus signs. ex: article+blog+faq+fgal+forum+igal+newsletter+event+poll+quiz+survey+tracker+wiki+img" ]
[ sort="fieldName_asc|fieldName_desc, valid fields: type, created, name, hits, shuffle" ]
[ split="y|n" ]
[ and="y|n" ]
}
Category Orphans Help
Display Tiki objects that have not been categorized
{catorphans
[ objects="wiki|article|blog|faq|fgal|forum|igal|newsletter|poll|quizz|survey|tracker" ]
}
Category Path Help
Insert the full category path for each category that this wiki page belongs to
{catpath
[ divider="String used to separate the categories in the path. Default character is >." ]
[ top="yes|no, default to no" ]
}
Center Help
Centers the plugin content in the wiki page
{CENTER( )}
text
{CENTER}
Chart Help
Displays a chart from TikiSheet. This plugin can be generated by the TikiSheet chart tool.
{CHART(
id="Data sheet ID"
type="BarStackGraphic|MultibarGraphic|MultilineGraphic|PieChartGraphic"
width="Width in pixels."
height="Height in pixels."
[ value="Required for pie charts" ]
[ x="Required for types other than pie chart" ]
[ y0="Required for types other than pie chart" ]
[ y1="" ]
[ y2="" ]
[ y3="" ]
[ y4="" ]
[ color="List of colors to use." ]
[ style="List of styles to use." ]
[ label="Labels for the series or values in the legend." ]
)}
Chart caption.
{CHART}
Code Help
Displays a snippet of code
{CODE(
[ caption="Code snippet label." ]
[ wrap="0|1, Enable word wrapping on the code to avoid breaking the layout." ]
[ colors="Syntax highlighting to use. May not be used with line numbers. Available: php, html, sql, javascript, css, java, c, doxygen, delphi, ..." ]
[ ln="0|1, may not be used with colors." ]
[ wiki="0|1, parse wiki syntax within the code snippet." ]
[ rtl="0|1, switch the text display from left to right to right to left" ]
[ ishtml="0|1, display the content as is instead of escaping HTML special chars" ]
)}
code
{CODE}
Definition List Help
Creates a definition list
{DL( )}
One entry per line. Each line is in "Term: Definition" format.
{DL}
Draw Help
Displays drawings in the wiki page
{draw
name="Name of the drawing to display."
}
Events Help
Includes the list of events from a calendar in the page.
{events
calendarid="Numeric"
[ maxdays="Numeric" ]
[ max="Numeric" ]
[ datetime="0|1" ]
[ desc="0|1" ]
}
Fade Help
Displays a label. On click, the block of content will fade in and fade out.
{FADE(
label="Label to display on first display"
)}
Wiki syntax containing the text to display.
{FADE}
Fancy List Help
Creates a fancy looking list
{FANCYLIST(
[ div="Use div instead of ol" ]
[ class="CSS class of the fancylist" ]
)}
One item per line starting with anything followed by ")".
{FANCYLIST}
Fancy Table Help
Displays the data using the Tikiwiki odd/even table style
{FANCYTABLE(
[ head="Heading row of the table, same format as the body section." ]
[ headclass="CSS Class to apply on the heading row." ]
)}
One row per line, cells separated by ~|~.
{FANCYTABLE}
File Help
Displays a link to an attachment to a wiki page and can display an image attachment.
{file
name="Gives the name of the attached file to link to"
[ desc="Comment" ]
[ page="Gives the name of another page the attached file is on. The file on that page is linked to instead. Only works with wiki pages" ]
[ showdesc="Shows the description as the link text instead of the file name" ]
[ image="Says that this file is an image, and should be displayed inline using the img tag" ]
}
Files Help
Displays a list of files from the File Gallery
{FILES(
[ galleryId="Gallery ID" ]
[ categId="Category ID:Category ID" ]
[ sort="name_asc" ]
[ showaction="y|n" ]
[ showfind="y|n" ]
[ showid="y|n" ]
[ showicon="y|n" ]
[ showname="y|n" ]
[ showfilename="y|n" ]
[ showsize="y|n" ]
[ showdescription="y|n" ]
[ showcreated="y|n" ]
[ showhits="y|n" ]
[ showlockedby="y|n" ]
[ showlmodified="y|n" ]
[ showauthor="y|n" ]
[ showcreator="y|n" ]
[ showgallery="y|n" ]
[ showfiles="y|n" ]
[ slideshow="y|n" ]
)}
Title
{FILES}
Flash video Help
Displays a SWF on the wiki page
{flash
movie="Complete URL to the movie to include."
[ width="Default width: 425" ]
[ height="Default height: 350" ]
[ quality="Flash video quality. Default value: high" ]
}
Group Help
Display wiki text if user is in one of listed groups
{GROUP(
[ groups="Pipe separated list of groups allowed to view the block. ex: Admins|Developers" ]
[ notgroups="Pipe separated list of groups denied from viewing the block. ex: Anonymous|Managers" ]
)}
Wiki text to display if conditions are met. The body may contain {ELSE}. Text after the marker will be displayed to users not matching the condition.
{GROUP}
Img
Displays an image.
{img
[ src="Full URL to the image to display." ]
[ alt="Alternate text to display if impossible to load the image." ]
[ height="Height of the image to display." ]
[ width="Width of the image to display." ]
[ link="Alias: lnk. Location the image should point to." ]
[ rel=""rel" attribute to add to the link." ]
[ title="Description." ]
[ align="Image alignment in the page. (left, right, center) Uses HTML IMG tag." ]
[ imalign="Image alignment in the flow of the document. (left, right, none) Uses CSS float property." ]
[ desc="Image description to display on the page." ]
[ usemap="Name of the image map to use for the image." ]
[ class="Style to apply to the image." ]
}
Include Help
Include a page's content.
{include
page="Wiki page name to include."
[ start="When only a portion of the page should be included, specify the marker from which inclusion should start." ]
[ stop="When only a portion of the page should be included, specify the marker at which inclusion should end." ]
}
Language Help
Displays the text only if the language matchs
{LANG(
[ lang="List of languages for which the block is displayed. Languages use the two letter language codes (ex: en, fr, es, ...). Multiple languages can be specified by separating codes by + signs." ]
[ notlang="List of languages for which the block is not displayed. Languages use the two letter language codes (ex: en, fr, es, ...). Multiple languages can be specified by separating codes by + signs." ]
)}
text
{LANG}
Mediaplayer Help
Simple mp3 or flv Player
{mediaplayer
[ mp3="Complete URL to the mp3 to include." ]
[ flv="Complete URL to the flv to include." ]
[ style="One of:mini|normal|maxi|multi" ]
}
Mini Quiz Help
Displays a miniquiz
{MINIQUIZ(
trackerId="Tracker ID"
)}
Instructions::Feedback
{MINIQUIZ}
Insert Module Help
Displays a module inlined in page. More parameters can be added, not supported by UI.
{module
module="Module name as known in Tikiwiki."
[ float="left|right|none" ]
[ decoration="y|n" ]
[ flip="y|n" ]
[ max="y|n" ]
[ np="0|1" ]
[ notitle="y|n" ]
}
Mouse Over Help
Create a mouseover feature on some text
{MOUSEOVER(
label="Text displayed on the page. The body is the mouseover content"
[ url="Destination link when moused-over text is clicked. Use http:// for external links" ]
[ text="DEPRECATED Text displayed on the mouseover. The body contains the text of the page." ]
[ width="Mouse over box width. Default: 400px" ]
[ height="Mouse over box height. Default: 200px" ]
[ offsetx="Shifts the overlay to the right by the specified amount of pixels in relation to the cursor. Default: 5px" ]
[ offsety="Shifts the overlay to the bottom by the specified amount of pixels in relation to the cursor. Default: 0px" ]
[ parse="y|n, parse the body of the plugin as wiki content. (Default to y)" ]
[ bgcolor="Default: #F5F5F5" ]
[ textcolor="#FFFFFF" ]
[ sticky="y|n, when enabled, popup stays visible until an other one is displayed or it is clicked." ]
[ padding="Default: 5px" ]
)}
Mouseover text if param label exists. Page text if text param exists
{MOUSEOVER}
Quote Help
Quote text by surrounding the text with a box, like the [QUOTE] BBCode
{QUOTE(
[ replyto="Name of the quoted person." ]
)}
Quoted text
{QUOTE}
Remarks Box Help
Displays a comment, tip, note or warning box
{REMARKSBOX(
type="tip|comment|note|warning"
title="Label displayed above the remark."
[ highlight="y|n" ]
[ icon="Icon ID." ]
)}
remarks text
{REMARKSBOX}
RSS Feed Help
Inserts an RSS feed output.
{rss
id="List of feed IDs separated by colons. ex: feedId:feedId2"
[ max="Amount of results displayed." ]
[ date="0|1" ]
[ desc="0|1|max length" ]
[ author="0|1" ]
}
Sheet Help
Displays the content of a spreadsheet in the page.
{SHEET(
id="Internal ID of the TikiSheet."
)}
Sheet Heading
{SHEET}
Sort Help
Sorts the plugin content in the wiki page
{SORT(
[ sort="asc|desc|shuffle" ]
)}
Data to sort, one entry per line.
{SORT}
Split Help
Split a page into rows and columns
{split
[ joincols="y|n Generate the colspan attribute if columns are missing" ]
[ fixedsize="y|n Generate the width attribute on the columns" ]
[ colsize="?" ]
[ first="col|line" ]
[ edit="y|n Display edit icon for each section" ]
[ customclass="add a class to customize the design" ]
}
Subscript Help
Displays text in subscript.
{SUB( )}
text
{SUB}
Superscript Help
Displays text in superscript (exponent).
{SUP( )}
text
{SUP}
Thumbnail Help
Displays the thumbnail for an image
{THUMB(
[ file="File ID from the file gallery." ]
[ id="Image ID from the image gallery." ]
[ image="URL to the image." ]
[ max="Maximum width or height for the image." ]
[ float="left|right|none" ]
[ url="Link target of the image." ]
[ original="y|n" ]
[ sticky="y|n" ]
)}
description
{THUMB}
Top Friends Help
List top scoring users.
{topfriends
[ limit="Maximum result count." ]
[ public="y|n" ]
}
Tracker Help
Displays an input form for tracker submit
{TRACKER(
trackerId="Tracker ID"
fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5"
[ action="Label on the submit button" ]
[ showtitle="y|n" ]
[ showdesc="y|n" ]
[ showmandatory="y|n" ]
[ embedded="y|n" ]
[ url="Url used for the field links" ]
[ values="Colon-separated list of values. Note that plugin arguments can be enclosed with double quotes "; this allows them to contain , or :" ]
[ sort="y|n" ]
[ preview="preview" ]
[ view="user|page" ]
[ itemId="itemId if you want to edit an item" ]
[ tpl="Name of the template used to display the tracker items." ]
[ wiki="Name of the wiki page containing the template to display the tracker items." ]
[ newstatus="o|p|c Default status applied to newly created items." ]
[ colwidth="## or ##% Specify the width in pixels or percentage of the first column in the tracker form." ]
)}
Confirmation message after posting form
{TRACKER}
Tracker Filter Help
Filters the items of a tracker, fields are indicated with numeric ids.
{TRACKERFILTER(
trackerId="Tracker ID"
[ fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5" ]
[ sort="y|n" ]
[ popup="Colon-separated list of fields to display on click. Example: 6:7" ]
[ stickypopup="y|n" ]
[ showtitle="y|n" ]
[ showlinks="y|n" ]
[ showdesc="y|n" ]
[ shownbitems="y|n" ]
[ showinitials="y|n" ]
[ showstatus="y|n" ]
[ showcreated="y|n" ]
[ showlastmodif="y|n" ]
[ showfieldname="y|n" ]
[ status="o|p|c|op|oc|pc|opc Which item status to list. o = open, p = pending, c = closed." ]
[ sort_mode="?" ]
[ max="?" ]
[ filterfield="Colon separated list of fields to allow filtering on." ]
[ filtervalue="?" ]
[ exactvalue="?" ]
[ checkbox="?" ]
[ goIfOne="?" ]
[ more="y|n" ]
[ moreurl="?" ]
[ view="user|page Select automatically the item of the current user or the page" ]
[ tpl="?" ]
[ wiki="?" ]
[ view_user="?" ]
[ itemId="List of items Ids" ]
[ url="link url" ]
[ ldelim="?" ]
[ rdelim="?" ]
[ list_mode="y|n If y, value will be truncated" ]
[ export="y|n" ]
[ compute="Sum or average all the values of a field and displays it at the bottom of the table. fieldId/sum:fieldId/avg" ]
filters="Example:2/d:4/r:5"
[ action="Label on the submit button" ]
[ displayList="y|n" ]
[ line="y|n - displays all the filter on the same line" ]
)}
notice
{TRACKERFILTER}
Tracker Item Field Help
Displays the value of a tracker item field or the wiki text if the value of the field is set or has a value(if itemId not specified, use the itemId of the url or the user tracker).
{TRACKERITEMFIELD(
[ trackerId="Numeric value." ]
[ itemId="Numeric value." ]
[ fieldId="Numeric value." ]
[ fields="Colon separated list of field IDs." ]
[ status="o|p|c|op|oc|pc|opc" ]
[ test="0|1" ]
value="Value to compare against."
)}
Wiki text containing an {ELSE} marker.
{TRACKERITEMFIELD}
Tracker List Help
Displays the output of a tracker content, fields are indicated with numeric ids.
{TRACKERLIST(
trackerId="Tracker ID"
[ fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5" ]
[ sort="y|n" ]
[ popup="Colon-separated list of fields to display on click. Example: 6:7" ]
[ stickypopup="y|n" ]
[ showtitle="y|n" ]
[ showlinks="y|n" ]
[ showdesc="y|n" ]
[ shownbitems="y|n" ]
[ showinitials="y|n" ]
[ showstatus="y|n" ]
[ showcreated="y|n" ]
[ showlastmodif="y|n" ]
[ showfieldname="y|n" ]
[ status="o|p|c|op|oc|pc|opc Which item status to list. o = open, p = pending, c = closed." ]
[ sort_mode="?" ]
[ max="?" ]
[ filterfield="Colon separated list of fields to allow filtering on." ]
[ filtervalue="?" ]
[ exactvalue="?" ]
[ checkbox="?" ]
[ goIfOne="?" ]
[ more="y|n" ]
[ moreurl="?" ]
[ view="user|page Select automatically the item of the current user or the page" ]
[ tpl="?" ]
[ wiki="?" ]
[ view_user="?" ]
[ itemId="List of items Ids" ]
[ url="link url" ]
[ ldelim="?" ]
[ rdelim="?" ]
[ list_mode="y|n If y, value will be truncated" ]
[ export="y|n" ]
[ compute="Sum or average all the values of a field and displays it at the bottom of the table. fieldId/sum:fieldId/avg" ]
)}
Notice
{TRACKERLIST}
Tracker Prefill Help
Displays a button to link to a page with a tracker plugin with prefilled tracker fields.
{trackerprefill
page="Tracker page name"
[ label="Button label." ]
field1="Field ID"
value1="Content of the field."
[ field2="Field ID" ]
[ value2="Content of the field." ]
[ field3="Field ID" ]
[ value3="Content of the field." ]
[ field4="Field ID" ]
[ value4="Content of the field." ]
[ field5="Field ID" ]
[ value5="Content of the field." ]
}
Tracker Stats Help
Displays some stat of a tracker content, fields are indicated with numeric ids.
{TRACKERSTAT(
trackerId="Tracker ID"
fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5"
[ show_percent="y|n" ]
[ show_bar="y|n" ]
[ status="o|p|c|op|oc|pc|opc Which item status to list. o = open, p = pending, c = closed." ]
[ show_link="y|n" ]
)}
Title
{TRACKERSTAT}
Tracker Timeline Help
Timeline view of a tracker, can be used to display event schedules or gantt charts.
{trackertimeline
tracker="Numeric value"
title="Tracker Field ID containing the item title."
summary="Tracker Field ID containing the summary of the item. The summary will be displayed on the timeline when the item is focused."
start="Tracker Field ID containing the element start date. The field must be a datetime/jscalendar field."
end="Tracker Field ID containing the element end date. The field must be a datetime/jscalendar field."
group="Tracker Field ID containing the element's group. Elements of a same group are displayed on the same row."
lower="Date from which element should be displayed. Date must be provided in YYYY-MM-DD HH:mm:ss format."
upper="Date until which element should be displayed. Date must be provided in YYYY-MM-DD HH:mm:ss format."
[ scale1="hour, day, week, month or year (default to hour)" ]
[ scale2="hour, day, week, month, year or empty (default to empty)" ]
[ link_group="Convert the group name to a link. (y|n)" ]
[ link_page="Tracker Field ID containing the page name for item details." ]
}
Translated Help
Links to a translated content
{TRANSLATED(
lang="Two letter language code of the language, ex: fr"
[ flag="Country name, ex: France" ]
)}
[url] or ((wikiname)) or ((inter:interwiki)) (use wiki syntax)
{TRANSLATED}
Vote Help
Displays some stat of a tracker content, fields are indicated with numeric ids.
{VOTE(
trackerId="Tracker ID"
fields="Colon-separated list of field IDs to be displayed. Example: 2:4:5"
[ show_percent="y|n" ]
[ show_bar="y|n" ]
[ show_stat="y|n" ]
[ show_stat_only_after="y|n" ]
[ show_creator="y|n" ]
[ status="o|p|c|op|oc|pc|opc Which item status to list. o = open, p = pending, c = closed." ]
[ float="left|right" ]
)}
Title
{VOTE}
Youtube Help
Display youtube video in a wiki page
{youtube
movie="URL to the Youtube video"
[ width="Width in pixels" ]
[ height="Height in pixels" ]
[ quality="quality" ]
}

Menu

Search

in:

Search Wiki PageName

Exact match

Site Language: English

Kindly hosted at:

ourproject.org Logo

Copyleft

Creative Commons License
Content on this site is licensed under a Creative Commons Attribution-ShareAlike 2.5 Spain License.