Changes between Version 6 and Version 7 of ContentDistributionSystem

Show
Ignore:
Timestamp:
01/14/07 22:07:08 (14 years ago)
Author:
benoitg
Comment:

Now up to date

Legend:

Unmodified
Added
Removed
Modified
  • ContentDistributionSystem

    v6 v7  
    1 = Content Distribution System = 
     1Feel free to contribute and/or format better 
     2[[PageOutline]] 
     3= At a glance = 
     4!WiFidog allows hotspot owners and administrators to create and associate content to hotspot login pages, portal pages or everywhere in the interface. The system can be accessed through the administration pages of the authentication server. The primary way to add/edit content is through the Reusable content library.  
    25 
    3 == Note == 
    4 This documentation needs to be updated. 
     6You can use the « Add new content » button to create content objects, which will be discussed later in this document. The « Show all content » button will display all the content stored in the system. It is important to note, that the normal view shows only « persistent, read-only » contents. Before you can associate a content to a node, a network or a user profile the content must be set to « persistent, read-only ». This prevents from deleting content too easily, and . 
    57 
    6 == At a glance == 
    7 !WiFidog allows hotspot owners and administrators to create and associate content to hotspots portal pages. The system can be accessed through the administration pages of the authentication server. Once logged in, you can always access the administration pages using the « My Profile » icon located in the upper left corner of the authentication server pages. Once in administration mode, you can access the « Content manager », which is located in the left menu. You will then see all the content you're allowed to manage. If you are a system administrator, you should see all the content stored in the CMS.  
     8= Attributes common to all content types = 
     9All content types share several of attributes, although Simple content types (see below), such as !TrivialLangstring and !SimplePicture, may not show most of them to keep them as simple as possible. 
    810 
    9 You can use the « Add new content » button to create content objects, which will be discussed later in this document. The « Show all content » button will display all the content stored in the system. It is important to note, that the normal view shows only « persistent, read-only » contents. Before you can associate a content to a node, a network or a user profile the content must be set to « persistent, read-only ». This prevents from deleting content too easily. 
     11== Metadata == 
     12The different Metadata attributes contain information about the content that will be displayed, meant for human consumption.  They are all optionnal.   
    1013 
    11 == List of available content types == 
    12  * !ContentGroup 
     14These attributes, if used, can be constituted of any Simple content type. Thus, a title could be a !TrivialLangstring, a SimplePicture or any other available content type. 
     15 
     16Note that if all Metadata attributes are empty, and authors are also empty, the content will display differently (no background, no margin). 
     17=== Title (and "Display the title?") === 
     18The title of the displayed content. 
     19* Note: Not present in Simple types, unless they are persistent. 
     20* Note: Will only show at display time if "Display the title?" is checked.  The reason for the "Display the title?" is to allow titling Persistend content types so they can e found in the reusable content library, without forcing you to actually display the title. 
     21* Standard display:  Will be displayed at the very top of the content area 
     22 
     23=== Description === 
     24A short description of the content. 
     25* Standard display:  Right side, below Authors 
     26=== Long description === 
     27Meant to provide more detailed information about the content.  Will be diplayed as a link to a page showing the actual Long description. 
     28* Standard display:  NOT YET USED (as of 2007-01-14) 
     29=== Information on this project === 
     30* Standard display:  Right side, below Description. 
     31== Content access control == 
     32=== Is part of reusable content library (protected from deletion)? === 
     33Indicates that the Content is meant to be reused. 
     34Reusable content will: 
     35* Be listed in the Reusable content library, and the node and network content assignation interfaces. 
     36* Will not be deleted if removed from a node or ContentGroup it is set to display at. 
     37Non-reusable content will: 
     38* Be completely deleted if removed from a node, network or ContentGroup. 
     39=== Content owner list === 
     40When you first create a content, you are it's sole owner.  You can add any other user as an owner, and the user will be allowed to modify the Content (Very useful for team curating of content groups, or for collective art).  
     41=== Is content author? === 
     42Once you add a owner, you can check the "Is content author?" box to indicate that the user actually created the content displayed (Art, text, image, etc.).  
     43* Standard display:  Will be displayed at the top of the right side, above the description. 
     44= The different content types = 
     45Note that many of the following content types have a "Simple" version, that contains no metadata, and are never persistent.  They are otherwise identical to their non "Simple" version.  Note that for historical reasons, a SimpleLangstring is actually named a !TrivialLangstring. 
     46Full Content class hierarchy 
     47This is the inheritance hierarchy for the content types.  A content will usually inherit all the administration interface of it's parent, and possible add it's own attributes. 
     48 * Content 
     49  * !ContentGroup 
     50   * !BannerAdGroup 
     51   * !PatternLanguage 
    1352 * !EmbeddedContent 
    1453 * File 
     54  * Picture 
     55   * !SimplePicture 
    1556 * !FlickrPhotostream 
    16  * HotspotRSS 
    17  * HTMLEditor 
    1857 * IFrame 
     58  * IFrameRest 
     59  * SimpleIFrame 
    1960 * Langstring 
    20  * !PatternLanguage 
    21  * Picture 
    22  * SimpleIFrame 
    23  * !TrivialLangstring 
    24  
    25 === Attributes that are common to all content types, except trivial ones === 
    26  
    27 All content types share a bunch of attributes, although trivial content types, such as !TrivialLangstring, do not use these attributes to keep them as simple as possible. 
    28  
    29 === All these attributes are optional : === 
    30  * Title 
    31  * Description 
    32  * Project information 
    33  * Sponsor 
    34  
    35 These attributes, if used, can be constituted of any content type. Thus, a title could be a !TrivialLangstring, a Picture or any other available content type. 
    36 Two other attributes : « Is persistent, read-only » and the « Content owners list » are used for administrative purposes. 
     61  * HTMLeditor 
     62  * !TrivialLangstring 
     63  * !SmartyTemplate 
     64   * !SimpleSmartyTemplate 
     65  * Stylesheet 
     66 * !RssAggregator 
     67 * UIShoutBox 
    3768 
    3869== !ContentGroup == 
    39 A !ContentGroup is not an actual content, it is simply a container that can contain a number of different contents. It regroups content elements which are displayed accordingly with the following attributes : 
    40  * Display order 
    41    * Randomly 
    42    * Sequential order 
    43  * Content rotation 
    44    * Always rotate 
    45    * Rotate once per day 
    46    * Rotate once per session             
    47    * Rotate each time the user changes node 
    48  * Display occurence 
    49    * Can be shown more than once 
    50    * Can only be shown once 
    51    * Can be shown more than once, but at different nodes 
    52  * Number of elements to display at once 
     70A !ContentGroup is not an actual content, it is a container that can contain a number of different contents pieces.  
     71'''ContentGroup configuration''' 
     72It's elements are displayed accordingly with the following attributes : 
     73 * In what order should the content displayed? 
     74   * Pick content elements randomly 
     75   * Pick content elements randomly, but not twice until all elements have been seen 
     76   * Pick content elements in sequential order 
     77 * When does the content rotate? 
     78   * Content always rotates 
     79   * Content rotates once per day 
     80   * Content rotates once per session            
     81   * Content rotates each time you change node 
     82 * Can content be shown more than once to the same user? 
     83   * Content can be shown more than once 
     84   * Content can only be shown once 
     85   * Content can be shown more than once, but not at the same node 
     86 * Pick how many elements for each display? 
     87'''!ContentGroup Elements''' 
     88You can create new content on the spot for each content element or select existing content in the Reusable Content Library. Remember : the existing content, must be set persistent before you can reuse it. 
    5389 
    54 A !ContentGroup can have its artistic content and locative content attributes activated, this will allow it to be displayed in the portal content page (which will expand all content elements). 
     90Also remember that you can assign a content group as an element of another, to nest them. 
    5591 
    56 You can create new content on the spot for each content element or select existing content using the combobox. Remember : the existing content, must be set persistent before you can reuse it. 
     92Each element will be displayed according to it's display conditions: 
     93 * Display order: In what order will the element display (Ignored if display type is random) 
     94 * Only display from (date) untill (date):  Content will only diplay during this date range.  Note that once expired, an element will not appear on the admin interface by default (but you can show them by clicking on "Show expired group elements").   
     95 * Only display at node(s): The nodes this element is allowed to display at. Note that an element can display at ANY node unless one or more nodes are selected. 
     96 
     97== !PatternLanguage == 
     98WRITEME! 
    5799 
    58100== !EmbeddedContent == 
     
    61103== File == 
    62104This content type allows you to either upload content that will be stored in the database or to specify a remote URL where the file can be downloaded. On the user side, this content will display a Download button. 
     105 
     106== Picture == 
     107Extends File, allows displaying a picture (optionally with a hyperlink). 
    63108 
    64109== !FlickrPhotostream == 
     
    70115Each selection mode has a number of different attributes.  
    71116 
    72 == HotspotRSS == 
    73 It is a very simple object that has no administrative option. It simply aggregates RSS feeds from the network and the node. For now, you must specify the feed URLs through the « Hotspot configuration » menu. 
    74 TODO: Update ... for RSS aggregator 
     117== IFrame == 
     118Allows displaying another web page in a configurable portion of the portal. 
     119 
     120== IFrameREST (DEPRECATED!) == 
     121Use a SmartyTemplate, which is much more powerful. 
    75122 
    76123== Langstring and !TrivialLangstring == 
    77 Most of the time, you will use !TrivialLangstring. This object supports translations for each locales specified in !WiFiDog (as of May 2005, !WiFiDog supports english and french). A !TrivialLangstring is perfect for displaying titles, descriptions, text documents, HTML fragments.  
     124Most of the time, you will use a !TrivialLangstring. This object supports translations for each locales specified in !WiFiDog (as of Jan 2007, !WiFiDog supports Français, English, Deutsch,                         , Español, Português' and 'ja_JP' => '日本語' (Japanese). 
    78125 
    79 == !PatternLanguage == 
    80 !PatternLanguage is a special project created by Kate Armstrong. It basically uses a !ContentGroup and a few custom pages to generate patterns. 
     126Note that simple HTML markup is allowed in Langstrings. 
    81127 
    82 == Picture == 
    83 Allows to upload or specify a URL to a picture using a File object. You can also specify Width and Height (these attributes are optionnal, when left blank the picture will be displayed at original size). 
     128==  HTMLeditor == 
     129A Langstring with a WYSIWYG GUI for creating HTML markup. 
     130 
     131== !SmartyTemplate == 
     132== Stylesheet == 
     133== !RssAggregator == 
     134== UIShoutBox ==