Changeset 7115


Ignore:
Timestamp:
Mar 16, 2016, 12:52:11 PM (6 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:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/developer/extensions.xml

    r6864 r7115  
    26892689     
    26902690    </sect2>
     2691   
     2692    <sect2 id="extensions_developer.start-page">
     2693      <title>Start page</title>
     2694     
     2695      <para>
     2696        This extension point can be used to change the start page that is
     2697        loaded after a use logs in to BASE. The normal start page is
     2698        the <menuchoice>
     2699          <guimenu>BASE</guimenu>
     2700          <guimenuitem>Home</guimenuitem>
     2701        </menuchoice> page. Extensions should implement the <interfacename
     2702        docapi="net.sf.basedb.clients.web.extensions.startpage">StartPageAction</interfacename>
     2703        interface. The current item in the <classname
     2704        docapi="net.sf.basedb.clients.web.extensions">JspContext</classname>
     2705        is the currently logged in user. All possible
     2706        start pages will be listed as a user configuration in the
     2707        <menuchoice>
     2708          <guimenu>BASE</guimenu>
     2709          <guimenuitem>Preferences</guimenuitem>
     2710        </menuchoice> dialog. The ID of the selected start page is stored as
     2711        a user setting. When the user is logging in to BASE the extension is
     2712        queried for the URL to load and the browser is redirected to that page.
     2713      </para>
     2714     
     2715      <para>
     2716        BASE provides a simple action factory implementation:
     2717        <classname docapi="net.sf.basedb.clients.web.extensions.startpage">FixedStartPageFactory</classname>.
     2718      </para>
     2719     
     2720    </sect2>
    26912721  </sect1>
    26922722 
  • trunk/doc/src/docbook/user/webclient.xml

    r7086 r7115  
    6666          and click the <guibutton>Login</guibutton> button.
    6767        </para>
     68       
     69        <note>
     70          <title>Problems with the start page</title>
     71          <para>
     72            If you have selected a non-default start page
     73            and there happens to be a problem with it
     74            it may prevent you from accessing BASE. In
     75            the worst scenario all that is displayed is a cryptic
     76            error message. In this case, it is good to know that
     77            holding down either one of the <guilabel>ALT</guilabel>
     78            or <guilabel>CTRL</guilabel> or <guilabel>SHIFT</guilabel>
     79            keys while clicking the <guibutton>Login</guibutton>
     80            button will force BASE to use the regular start page.
     81          </para>
     82        </note>
     83       
    6884      </sect2>
    6985     
     
    858874                high precision (eg. 135000 instead of 135000.00).
    859875                </para>
     876              </listitem>
     877            </varlistentry>
     878
     879            <varlistentry>
     880              <term>
     881                <guilabel>Dialogs</guilabel>
     882              </term>
     883              <listitem>
     884                <para>
     885                  Check the <guilabel>Remember positions</guilabel> option
     886                  to let BASE remember the position and size of dialogs
     887                  so that they always open in the same place as the last
     888                  time. The positions are remembered during the current
     889                  session only and are forgotten if the browser is closed.
     890                </para>
     891              </listitem>
     892            </varlistentry>
     893           
     894            <varlistentry>
     895              <term>
     896                <guilabel>Start page</guilabel>
     897              </term>
     898              <listitem>
     899                <para>
     900                  Select the start page that should be displayed after logging
     901                  in to BASE. The default and only built-in start page is the
     902                  <menuchoice>
     903                    <guimenu>BASE</guimenu>
     904                    <guimenuitem>Home</guimenuitem>
     905                  </menuchoice>. Other start pages may be enabled by
     906                  extensions.
     907                </para>
     908               
     909                <note>
     910                  <title>Problems with the start page</title>
     911                  <para>
     912                    If there are problems with the selected start page
     913                    it may prevent the user from accessing BASE. In
     914                    the worst scenario all that is displayed is a cryptic
     915                    error message. In this case, it is good to know that
     916                    holding down either one of the <guilabel>ALT</guilabel>
     917                    or <guilabel>CTRL</guilabel> or <guilabel>SHIFT</guilabel>
     918                    keys while clicking the <guibutton>Login</guibutton>
     919                    button will force BASE to use the regular start page.
     920                  </para>
     921                </note>
     922               
    860923              </listitem>
    861924            </varlistentry>
  • trunk/src/clients/web/net/sf/basedb/clients/web/extensions/startpage/StartPageAction.java

    r7113 r7115  
    5959    as a placeholder for the current session id.
    6060    Eg. <code>my_alternate_startpage.jsp?ID=$SESSION-ID$</code>
     61    @return The URL to the page to load, or null to load the regular start page
    6162  */
    6263  public String getUrl();
Note: See TracChangeset for help on using the changeset viewer.