Historique de la page

...

• esup-lecture.xml: main configuration file. Contexts and CategoryProfiles definition.
  It also deals with <category>.xml: remote xml file referecend by CategoryProfiles.
  
• mappings.xml: declarations about xslt transformation for interface display
• portlet.xml: it needs declaration of portal user attributes used by Lecture Portlet
• auth.xml: auth configuration

  Remarque
  XML Elements or attributes not explained here (but in dtd) implements features that are not yet supported.

esup-lecture.xml

...

These files describe contexts, category profiles and userId definition. Here is the structure of this file (for more information, look at dtd esup-lecture.dtd):

...

Element channelConfig  :

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE channelConfig SYSTEM "lecture-config.dtd" >
<channelConfig>

  <!-- contexts definition -->
  <context> ... </context>
  <context> ... </context>
  ...

  <!-- category profile definition -->
  <categoryProfile> ... </categoryProfile>
  <categoryProfile> ... </categoryProfile>
  ...

</channelConfig>

...

Element context :

<context
   name = "Démonstration Esup-Lecture"
   id = "default">
   <description>Context de démo</description>
   <refCategoryProfile refId="demo1"/>
   <refCategoryProfile refId="demo2"/>
   ...
</context>

...

A context have the following attributes :

• id
• name (displayed on interface)
• description (displayed on interface)
• refCategoryProfile references on category profile declared in this context (using category profile id)You can declare as many category profiles as you want in a context. Each category profile must be defined in an element categoryProfile. A same categoryProfile can be declared in many contexts.
• treeVisible (yes | no) : If "yes", users can see the left panel (tree of categories ans sources). Yes by default

...

Element categoryProfile :

<categoryProfile   name="Categorie de démo"
   id="demo1"
   urlCategory="http://partages.univ-rennes1.fr/files/partages/Services/CRI/SI/conf_lecture_gwe_ray/demo1.xml"
   trustCategory="no"
   access="public"
   ttl = "3600"
   timeout = "3000">
   <visibility> ... </visibility>
</categoryProfile>

Here is defined a A category profile with have the following attributes :

• id,
  name,
  urlCategory : url to get back a xml category file on a remote server
  trustCategory ( yes | no ) : If it is "yes", visibility rights used are those of remote category and sources. If it is "no", visibility rights on category and sources used are those of this category profile, defined in visibility element.
  access ( public | cas ) : access of the category is public or cas because it needs CAS proxy ticket for authentication (for more information about CAS configuration see Configuration en déploiement portlet of the ESUP-Commons documentation and CAS en mode portletof the part Utilisation de CAS (French) of the of ESUP-Lecture documentation)
  ttl (seconds) : time to live of the remote category and its sources
  timeout (milliseconds) : time trying to get the category
  visibility : define group visibility for category referenced by this category profile. It is used only if trustCategory is set to "no"
  userCanMarkRead (yes | no) : If "yes", users can mark items of the category as read ot not read. Yes by default*
  element visibility :

<visibility>
   <allowed/>
   <autoSubscribed/>
   <obliged>
      <group name="local.0"/>
      <group .../>
      ...
      <regular attribute="sn" value="user" />
      <regular .../>
      ...
   </obliged>
</visibility>

...

• regular : user check regular, in the example : user value of portal attribute "sn" is "user" - see "portlet.xml" section.* element categoryin xml category file (describe by dtd category.dtd), provided by remote server, requested by urlCategory of esup-lecture.xml :
  

  Bloc de code
  <?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE category SYSTEM "category.dtd"> <category name="Différents RSS"> <description>Très belle description !</description> <sourceProfiles> <sourceProfile> ... </sourceProfiles> <sourceProfile> ... </sourceProfiles> ... </sourceProfiles> <visibility> ... </visibility> </category>

  A category has a name and a description (displayed on interface), and
  • a list of source profiles
  • visibility : define group visibility for this category. It is used only if trustCategory attribute of referencing categoryProfile is set to "yes" else visibility of category profile is used - optional -

<category>.xml

• element sourceProfile in xml category file :
  

  Bloc de code
  <sourceProfile id="un" access="public" name="Incidents techniques Rennes 1" specificUserContent="no" url="http://info.cri.univ-rennes1.fr/rss/rss.php"> <visibility> ... </visibility> </sourceProfile>

  A source profile has an id, a name (displayed on interface) and
  • access ( public | cas ) : access of the source is public or cas because it needs CAS proxy ticket for authentication (for more information about CAS configuration see Configuration en déploiement portlet of the ESUP-Commons documentation and CAS en mode portletof the part Utilisation de CAS (French) of the of ESUP-Lecture documentation)
  • specificUserContent ( yes | no) : if it is "yes", source content is specific to user. If it is "no", source content is the same for every users (If your configure with "yes" then application assumes that content can be deferent for each user (may be because of specific content due to profiling according to authentication). In this case application doesn't use any cache for the source. So be careful before use "yes" for this property.)
  • url : url to get xml stream of the source
  • timeout (milliseconds) : Time trying to get the source. Parent category timeout is used is it is not defined here
  • visibility : define group visibility for source refered by this source profile. It is used only if trustCategory attribute of referencing categoryProfile is set to "yes" else visibility category profile is used - optional -

    Remarque
    Be carefull to manage unique id for every sources profiles defined in categories : application does not yet manage it.

...