Historique de la page

...

• logging/log4j.properties for logging configuration
• esup-lecture.xml for global configuration esup-lecture.xml

...

Content configuration

To adapt to your environment, edit these configuration files:

• element guestUser in esup-lecture.xml:

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

guestUser is an optional property. Default value is "guest".
If the current connected user name equals guestUser property, then all controls used for personalisation (change tree size buttons, mark an item as read button, edit button, etc.) are hidden.
This is used in Portlet mode when esup-lecture is used in a portal unauthenticated view.

Content configuration

...

• 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 file contains some technical parameters (guestUser, ttl) and describe the contents displayed (contexts, category profiles). 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>

  <!-- guestUser definition -->
  <guestUser> ... </guestUser>

  <!-- ttl definition -->
  <ttl> ... </ttl>

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

• 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>

  <!-- guestUsercategory profile definition -->
  <guestUser><categoryProfile> ... </guestUser>categoryProfile>

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

</context>
  ...

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

</channelConfig>

...

channelConfig>

channelConfig is the root element, it is of course mandatory and all others elements must be described under it.

Element guestUser :

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

guestUser is an optional property. Default value is "guest".
If the current connected user name equals guestUser property, then all controls used for personalisation (change tree size buttons, mark an item as read button, edit button, etc.) are hidden.
This is used in Portlet mode when esup-lecture is used in a portal unauthenticated view.

Element ttl :

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

guestUser ttl is an optional property. Default value is "guest".
If the current connected user name equals guestUserproperty, then all controls used for personalisation (change tree size buttons, mark an item as read button, edit button, etc.) are hidden.
This is used in Portlet mode when esup-lecture is used in a portal unauthenticated view0 (zero). If not used, the configTtl property of bean channel (see properties/domain/domain.xml) is used instead.

It tunes the time in seconds the two configuration files (esup-lecture.xml and mappings.xml) will stay in cache, that is the time between two reloadings of theses files. This allow to change the configuration files without reloading the portlet. A value of zero means no reloading.

Element context :

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

...