Changes between Initial Version and Version 1 of ContentDistributionSystem

Show
Ignore:
Timestamp:
01/09/06 00:45:10 (14 years ago)
Author:
fproulx
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ContentDistributionSystem

    v1 v1  
     1= Content Distribution System = 
     2 
     3== Note == 
     4This documentation needs to be updated. 
     5 
     6== At a glance == 
     7WiFidog 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 acess 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 
     9You 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. 
     10 
     11'''Documentation by [wiki:FrancoisProulx François Proulx]''' 
     12 
     13== List of available content types == 
     14 * ContentGroup 
     15 * EmbeddedContent 
     16 * File 
     17 * FlickrPhotostream 
     18 * HotspotRSS 
     19 * HTMLEditor 
     20 * IFrame 
     21 * Langstring 
     22 * PatternLanguage 
     23 * Picture 
     24 * SimpleIFrame 
     25 * TrivialLangstring 
     26 
     27=== Attributes that are common to all content types, except trivial ones === 
     28 
     29All 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. 
     30 
     31=== All these attributes are optional : === 
     32 * Title 
     33 * Description 
     34 * Project information 
     35 * Sponsor 
     36 
     37These 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. 
     38Two other attributes : « Is persistent, read-only » and the « Content owners list » are used for administrative purposes. 
     39 
     40== ContentGroup == 
     41A 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 : 
     42 * Display order 
     43   * Randomly 
     44   * Sequential order 
     45 * Content rotation 
     46   * Always rotate 
     47   * Rotate once per day 
     48   * Rotate once per session             
     49   * Rotate each time the user changes node 
     50 * Display occurence 
     51   * Can be shown more than once 
     52   * Can only be shown once 
     53   * Can be shown more than once, but at different nodes 
     54 * Number of elements to display at once 
     55 
     56A 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). 
     57 
     58You 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. 
     59 
     60== EmbeddedContent == 
     61This content type allows you to embed multimedia content in the portal pages. It support an unlimited number of fallback content (alternative content), which will be displayed if the client's browser cannot supported the multimedia content. 
     62 
     63== File == 
     64This 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. 
     65 
     66== FlickrPhotostream == 
     67« Flickr is a digital photo sharing website and web services suite. ... The service is widely used by bloggers as a photo repository. ». What's nice about Flickr, is that you can access all photos and metadatas through a well-documented API. Using this API we can display photos from the Flickr photosets on WiFiDog's portal pages. You will need a Flickr API key to active this content type. API keys are free for non-commercial use (http://www.flickr.com/services/api/misc.api_keys.html).  
     68We support three Flickr photo selection modes : 
     69 * By group 
     70 * By tags 
     71 * By user 
     72Each selection mode has a number of different attributes.  
     73 
     74== HotspotRSS == 
     75It 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. 
     76TODO: Update ... for RSS aggregator 
     77 
     78== Langstring and TrivialLangstring == 
     79Most 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.  
     80 
     81== PatternLanguage == 
     82PatternLanguage is a special project created by Kate Armstrong. It basically uses a ContentGroup and a few custom pages to generate patterns. 
     83 
     84== Picture == 
     85Allows 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).