Changeset 7115

Timestamp:

Mar 16, 2016, 12:52:11 PM (8 years ago)

Author:

Nicklas Nordborg

Message:

References #1995: Add extension point for selecting start page

Updated documentation with information about this feature.

Also noted that the "Remember dialog positions" (#1825) feature was not documented and added a short text about this.

Location:

trunk

Files:

• doc/src/docbook/developer/extensions.xml (modified) (1 diff)
• doc/src/docbook/figures/preferences_appearance.png (modified) (previous)
• doc/src/docbook/user/webclient.xml (modified) (2 diffs)
• src/clients/web/net/sf/basedb/clients/web/extensions/startpage/StartPageAction.java (modified) (1 diff)

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

@@ -2689 +2689 @@
       
     </sect2>
+    
+    <sect2 id="extensions_developer.start-page">
+      <title>Start page</title>
+      
+      <para>
+        This extension point can be used to change the start page that is
+        loaded after a use logs in to BASE. The normal start page is 
+        the <menuchoice>
+          <guimenu>BASE</guimenu>
+          <guimenuitem>Home</guimenuitem>
+        </menuchoice> page. Extensions should implement the <interfacename 
+        docapi="net.sf.basedb.clients.web.extensions.startpage">StartPageAction</interfacename>
+        interface. The current item in the <classname 
+        docapi="net.sf.basedb.clients.web.extensions">JspContext</classname> 
+        is the currently logged in user. All possible 
+        start pages will be listed as a user configuration in the 
+        <menuchoice>
+          <guimenu>BASE</guimenu>
+          <guimenuitem>Preferences</guimenuitem>
+        </menuchoice> dialog. The ID of the selected start page is stored as
+        a user setting. When the user is logging in to BASE the extension is
+        queried for the URL to load and the browser is redirected to that page.
+      </para>
+      
+      <para>
+        BASE provides a simple action factory implementation:
+        <classname docapi="net.sf.basedb.clients.web.extensions.startpage">FixedStartPageFactory</classname>.
+      </para>
+      
+    </sect2>
   </sect1>
   

trunk/doc/src/docbook/user/webclient.xml

@@ -66 +66 @@
           and click the <guibutton>Login</guibutton> button.
         </para>
+        
+        <note>
+          <title>Problems with the start page</title>
+          <para>
+            If you have selected a non-default start page
+            and there happens to be a problem with it 
+            it may prevent you from accessing BASE. In
+            the worst scenario all that is displayed is a cryptic
+            error message. In this case, it is good to know that
+            holding down either one of the <guilabel>ALT</guilabel>
+            or <guilabel>CTRL</guilabel> or <guilabel>SHIFT</guilabel>
+            keys while clicking the <guibutton>Login</guibutton>
+            button will force BASE to use the regular start page.
+          </para>
+        </note>
+        
       </sect2>
       
@@ -858 +874 @@
                 high precision (eg. 135000 instead of 135000.00).
                 </para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>
+                <guilabel>Dialogs</guilabel>
+              </term>
+              <listitem>
+                <para>
+                  Check the <guilabel>Remember positions</guilabel> option
+                  to let BASE remember the position and size of dialogs
+                  so that they always open in the same place as the last
+                  time. The positions are remembered during the current 
+                  session only and are forgotten if the browser is closed.
+                </para>
+              </listitem>
+            </varlistentry>
+            
+            <varlistentry>
+              <term>
+                <guilabel>Start page</guilabel>
+              </term>
+              <listitem>
+                <para>
+                  Select the start page that should be displayed after logging 
+                  in to BASE. The default and only built-in start page is the 
+                  <menuchoice>
+                    <guimenu>BASE</guimenu>
+                    <guimenuitem>Home</guimenuitem>
+                  </menuchoice>. Other start pages may be enabled by
+                  extensions.
+                </para>
+                
+                <note>
+                  <title>Problems with the start page</title>
+                  <para>
+                    If there are problems with the selected start page
+                    it may prevent the user from accessing BASE. In
+                    the worst scenario all that is displayed is a cryptic
+                    error message. In this case, it is good to know that
+                    holding down either one of the <guilabel>ALT</guilabel>
+                    or <guilabel>CTRL</guilabel> or <guilabel>SHIFT</guilabel>
+                    keys while clicking the <guibutton>Login</guibutton>
+                    button will force BASE to use the regular start page.
+                  </para>
+                </note>
+                
               </listitem>
             </varlistentry>

trunk/src/clients/web/net/sf/basedb/clients/web/extensions/startpage/StartPageAction.java

@@ -59 +59 @@
     as a placeholder for the current session id.
     Eg. <code>my_alternate_startpage.jsp?ID=$SESSION-ID$</code> 
+    @return The URL to the page to load, or null to load the regular start page
   */
   public String getUrl();