Changeset 6628 for trunk/doc/src/docbook/developer/extensions.xml

Timestamp:

Nov 26, 2014, 7:47:24 AM (9 years ago)

Author:

Nicklas Nordborg

Message:

References #1886: Extension point for "skinning" web gui

Wrote some documentation about the new extension point.

File:

• trunk/doc/src/docbook/developer/extensions.xml (modified) (1 diff)

trunk/doc/src/docbook/developer/extensions.xml

@@ -2536 +2536 @@
       
     </sect2>
+    
+    <sect2 id="extensions_developer.skins">
+      <title>Skins</title>
+      
+      <para>
+        This extension point can be used to change the visual appearance of BASE. Contrary
+        to other extension points, providing actions are optional. The skinning is
+        done by having the action factory set style sheet and script files on the <classname 
+        docapi="net.sf.basedb.clients.web.extensions">JspContext</classname> instance.
+        Typically the style sheet override or set some properties defined by the BASE
+        core stylesheets.
+      </para>
+      
+      <para>
+        Actions may be provided and should then implement the <interfacename 
+        docapi="net.sf.basedb.clients.web.extensions.skin">SkinAction</interfacename>
+        interface. Actions are needed if the skin extension wants to modify the
+        fav-icon or include some data in a hidden <sgmltag class="starttag">div</sgmltag>
+        tag. For this to work, the action must also implement the <interfacename 
+        docapi="net.sf.basedb.clients.web.extensions">DynamicActionAttributes</interfacename>
+        interface, since only the dynamic attribute values are included in the web page.
+      </para>
+      
+      <para>
+        BASE provides a simple action factory implementation,
+        <classname docapi="net.sf.basedb.clients.web.extensions.skin">FixedSkinActionFactory</classname>,
+        that supports all of the above.
+      </para>
+      
+    </sect2>
   </sect1>