AWA_Wikis

Stephane Carrez edited this page Jun 12, 2016 · 5 revisions

Wiki module

Introduction

The Wikis module provides a complete wiki system which allows users to create their own wiki environment with their wiki pages.

Events

The wikis exposes a number of events which are posted when some action are performed at the service level.

wiki-create-page

This event is posted when a new wiki page is created.

wiki-create-content

This event is posted when a new wiki page content is created. Each time a wiki page is modified, a new wiki page content is created and this event is posted.

Wiki Beans

Several bean types are provided to represent and manage the blogs and their posts. The blog module registers the bean constructors when it is initialized. To use them, one must declare a bean definition in the application XML configuration.

Ada Beans

Name Description
wikiView The wiki page with all its information to display it.
wikiImageInfo The information about an image used by a wiki page.
wikiPageInfo The wiki page information bean gives the various statistics and information about a wiki page.
wikiFormatList A localized list of wiki page formats to be used for a f:selectItems
adminWiki The list of wikis and pages that the current user can access and update.
adminWikiSpace The wiki space bean to create and edit the wiki space configuration.
wikiPage The wiki page bean gives the full content and information about a wiki page.
wikiList The list of wiki pages.
wikiVersionList The list of wiki page versions.
wikiTagSearch The wiki tag search bean.
wikiTagCloud The list of tags associated with a wiki page entities.
wikiTags The wiki tag editor bean.
wikiPageStats The counter statistics for a wiki page

Permissions

Name Name Description
wiki-space-create awa_workspace
wiki-space-update awa_wiki_space Grant the edit permission on the wiki space owner only
wiki-space-delete awa_wiki_space Grant the delete permission on the wiki space owner only
wiki-page-view awa_wiki_space Grant the view wiki page permission when the page is public or when an ACL link exist betwen the user and the wiki space
wiki-page-create awa_wiki_space Grant the create wiki page permission when an ACL link exist betwen the user and the wiki space
wiki-page-update awa_wiki_space
wiki-page-delete awa_wiki_space

Configuration

Name Description
wikis.image_prefix The URL base prefix to be used for Wiki images.
#{contextPath}/wikis/images/
wikis.page_prefix The URL base prefix to be used for Wiki pages.
#{contextPath}/wikis/view/

Queries

AWA.Wikis.Models.Wiki_View_Info

The information about a wiki page.

Type Ada Name Description
Identifier id the wiki page identifier.
String name the wiki page name.
String title the wiki page title.
Boolean is_public whether the wiki is public.
Integer version the last version.
Integer read_count the number of times the page was displayed.
Date date the wiki page creation date.
AWA.Wikis.Models.Format_Type format the wiki page format.
String content the wiki page content.
String save_comment the wiki version comment.
String left_side the wiki page left side panel.
String right_side the wiki page right side panel.
AWA.Wikis.Models.Format_Type side_format the wiki side format.
String author the wiki page author.
Identifier acl_id the acl Id if there is one.

AWA.Wikis.Models.Wiki_Page_Info

The information about a wiki page.

Type Ada Name Description
Identifier id the wiki page identifier.
String name the wiki page name.
String title the wiki page title.
Boolean is_public whether the wiki is public.
Integer last_version the last version.
Integer read_count the read count.
Date create_date the wiki creation date.
String author the wiki page author.

AWA.Wikis.Models.Wiki_Version_Info

The information about a wiki page version.

Type Ada Name Description
Identifier id the wiki page identifier.
String comment the wiki page version comment.
Date create_date the wiki page creation date.
Integer page_version the page version.
String author the wiki page author.

AWA.Wikis.Models.Wiki_Info

The list of wikis.

Type Ada Name Description
Identifier id the wiki space identifier.
String name the wiki name.
Boolean is_public whether the wiki is public.
Date create_date the wiki creation date.
Integer page_count the number of pages in the wiki.

Model


Generated by Dynamo from awa-wikis.ads