Changeset 30298

Show
Ignore:
Timestamp:
02/19/08 17:44:03 (9 months ago)
Author:
ogrisel
Message:

comment formatting + update

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • org.nuxeo.ecm.platform/branches/5.1/nuxeo-platform-webapp-core/src/main/java/org/nuxeo/ecm/webapp/liveedit/LiveEditBootstrapHelper.java

    r30249 r30298  
    5555 
    5656/** 
    57  * The bootstrap module is: - called from browsed page as a command (edit a 
    58  * document, create new document, etc.); - composing a specifc URL as result, 
    59  * triggering the bootstrap addon to popup; - the addon come back with the URL 
    60  * composed allowing the module to create the bootstrap file. The file contains 
    61  * various data as requested in the URL; - the XML file is now available to 
    62  * addon which presents it to the client plugin. 
     57 * The LiveEdit bootstrap procedure works as follows: 
     58 * <ul> 
     59 * 
     60 * <li>browsed page calls a JSF function from the DocumentModelFunctions class 
     61 * (edit a document, create new document, etc.) to generate;</li> 
     62 * 
     63 * <li>composing a specifc URL as result, triggering the bootstrap addon to 
     64 * popup;</li> 
     65 * 
     66 * <li>the addon come back with the URL composed allowing the present seam 
     67 * component to create the bootstrap file. The file contains various data as 
     68 * requested in the URL;</li> 
     69 * 
     70 * <li>the XML file is now available to addon which presents it to the client 
     71 * plugin.</li> 
     72 * 
     73 * </ul> 
    6374 * 
    6475 * Please refer to the specification files in nuxeo-platform-ws-jaxws/doc/ for