You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lenya.apache.org by Comiotto Thomas <th...@unicom.unizh.ch> on 2006/08/28 18:40:03 UTC

1.2 Neutron Support

Hi devs

I have attached Neutron support for 1.2.X to the Bugzilla. For  
information about Neutron check  
http://www.wyona.org/osr-101/index.html.

Below a short README (could go to a Wiki page).

--
Bests
Thomas

++++++
README

Neutron is a Protocol for remote content authoring. Check  
http://www.wyona.org/osr-101/index.html for more information. Lenya  
1.2.X currently supports the following Neutron remote operations:

  - Entering a Neutron request/response chain by document introspection.
  - Neutron authentication for embedded and stand-alone clients.
  - Open/save document
  - Checkin/out document
  - Lock/unlock document
  - Document styling by xslt for WYSIWYG editing


AVAILABLE CLIENTS

Currently the only Neutron enabled client is Ulysses. Ulysses is GPL  
licenced and available for download at http://demo.ulysses.wyona.org/.


RELEVANT FILES

  - Neutron authentication and introspection (webapp/sitemap.xmap)
  - Neutron usecase matchers  
(/lenya/webapp/lenya/usecases/neutron/usecase-neutron.xmap)
  - Flowscript with usecase related methods  
(/lenya/webapp/lenya/usecases/neutron/neutron.js)
  - jx-templates for protocol messages  
(/lenya/webapp/lenya/usecases/neutron/jx)


USAGE

A Neutron request/response chain is initiated by parsing an  
introspection file. Introspection files contain commandURLs and client  
configuration directives needed for remote operation.

Neutron clients can be pointed to an introspection file by embedding  
introspection links into accessible resources (web pages for instance).  
To enable Neutron support for your Lenya publication add the following  
directive to the <head> tag of the web pages generated by Lenya:

<link href="?lenya.usecase=neutron&lenya.step=introspect"  
type="application/neutron+xml" rel="neutron-introspection" />

This will enable Neutron enabled clients to edit the underlying source  
of the requested document.


WYSIWYG EDITING

Neutron has support for WYSIWYG editing based on xslt stylesheets,  
whereas the server has to provide a stylesheet that transforms the  
editable document source to xhtml. Because document styling depends on  
the document type, Lenya 1.2.X Neutron styling directives have to be  
configured on publication level. To enable Neutron WYSIWYG-editing do  
the following:

1. Copy introspection.jx from  
webapp/lenya/usecases/neutron/jx/introspection.jx to  
{yourpub}/lenya/usecases/neutron/jx/introspection.jx

2. Add the following to the copied introspection file (or uncomment if  
already there):

<edit>
..
   <styles>
     <style  
href="${cocoon.parameters['base-url']}${cocoon.parameters['document- 
url']}?lenya.usecase=neutron&#38;lenya.step=xsl"/>
   </styles>
</edit>

3. Copy the file neutron-styles.xmap from the default publication to  
{yourpub}/lenya/usecases/neutron. This file contains a usecase matcher  
that generates the xslt sent to the client. The relevant part of the  
file is:

      <map:match type="usecase" pattern="neutron">
         <map:match type="step" pattern="xsl">
         .. <!-- add the code generating a xslt providing for a  
document2xhtml transform here. -->
         </map:match>
      </map:match>

4. Your done.









---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: 1.2 Neutron Support

Posted by Comiotto Thomas <th...@unicom.unizh.ch>.
Hi Michi
>
> http://issues.apache.org/bugzilla/show_bug.cgi?id=40337
>

Yes it is.

One might want to improve styles for the default publication I guess.

On the other hand, I wouldn't put to much work in that until view 
templating has made it to the Neutron specs and Ulysses supports it. 
Moreover, the current XSLT serves as a good (while still somewhat 
shrink wrapped) test case for Ulysses, because it makes pretty clear 
where the WYSIWYG rendering flaws are.

--
Bests
Thomas


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: 1.2 Neutron Support

Posted by Michael Wechner <mi...@wyona.com>.
Comiotto Thomas wrote:

> Hi devs
>
> I have attached Neutron support for 1.2.X to the Bugzilla.



sorry for the noice. I guess it's

http://issues.apache.org/bugzilla/show_bug.cgi?id=40337

Thanks

Michi



-- 
Michael Wechner
Wyona      -   Open Source Content Management   -    Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org
+41 44 272 91 61


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org


Re: 1.2 Neutron Support

Posted by Michael Wechner <mi...@wyona.com>.
Comiotto Thomas wrote:

> Hi devs
>
> I have attached Neutron support for 1.2.X to the Bugzilla.


very cool :-) Can you send a pointer to Bugzilla entry?

Thanks

Michi

> For  information about Neutron check  
> http://www.wyona.org/osr-101/index.html.
>
> Below a short README (could go to a Wiki page).
>
> -- 
> Bests
> Thomas
>
> ++++++
> README
>
> Neutron is a Protocol for remote content authoring. Check  
> http://www.wyona.org/osr-101/index.html for more information. Lenya  
> 1.2.X currently supports the following Neutron remote operations:
>
>  - Entering a Neutron request/response chain by document introspection.
>  - Neutron authentication for embedded and stand-alone clients.
>  - Open/save document
>  - Checkin/out document
>  - Lock/unlock document
>  - Document styling by xslt for WYSIWYG editing
>
>
> AVAILABLE CLIENTS
>
> Currently the only Neutron enabled client is Ulysses. Ulysses is GPL  
> licenced and available for download at http://demo.ulysses.wyona.org/.
>
>
> RELEVANT FILES
>
>  - Neutron authentication and introspection (webapp/sitemap.xmap)
>  - Neutron usecase matchers  
> (/lenya/webapp/lenya/usecases/neutron/usecase-neutron.xmap)
>  - Flowscript with usecase related methods  
> (/lenya/webapp/lenya/usecases/neutron/neutron.js)
>  - jx-templates for protocol messages  
> (/lenya/webapp/lenya/usecases/neutron/jx)
>
>
> USAGE
>
> A Neutron request/response chain is initiated by parsing an  
> introspection file. Introspection files contain commandURLs and 
> client  configuration directives needed for remote operation.
>
> Neutron clients can be pointed to an introspection file by embedding  
> introspection links into accessible resources (web pages for 
> instance).  To enable Neutron support for your Lenya publication add 
> the following  directive to the <head> tag of the web pages generated 
> by Lenya:
>
> <link href="?lenya.usecase=neutron&lenya.step=introspect"  
> type="application/neutron+xml" rel="neutron-introspection" />
>
> This will enable Neutron enabled clients to edit the underlying 
> source  of the requested document.
>
>
> WYSIWYG EDITING
>
> Neutron has support for WYSIWYG editing based on xslt stylesheets,  
> whereas the server has to provide a stylesheet that transforms the  
> editable document source to xhtml. Because document styling depends 
> on  the document type, Lenya 1.2.X Neutron styling directives have to 
> be  configured on publication level. To enable Neutron WYSIWYG-editing 
> do  the following:
>
> 1. Copy introspection.jx from  
> webapp/lenya/usecases/neutron/jx/introspection.jx to  
> {yourpub}/lenya/usecases/neutron/jx/introspection.jx
>
> 2. Add the following to the copied introspection file (or uncomment 
> if  already there):
>
> <edit>
> ..
>   <styles>
>     <style  
> href="${cocoon.parameters['base-url']}${cocoon.parameters['document- 
> url']}?lenya.usecase=neutron&#38;lenya.step=xsl"/>
>   </styles>
> </edit>
>
> 3. Copy the file neutron-styles.xmap from the default publication to  
> {yourpub}/lenya/usecases/neutron. This file contains a usecase 
> matcher  that generates the xslt sent to the client. The relevant part 
> of the  file is:
>
>      <map:match type="usecase" pattern="neutron">
>         <map:match type="step" pattern="xsl">
>         .. <!-- add the code generating a xslt providing for a  
> document2xhtml transform here. -->
>         </map:match>
>      </map:match>
>
> 4. Your done.
>
>
>
>
>
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
> For additional commands, e-mail: dev-help@lenya.apache.org
>
>


-- 
Michael Wechner
Wyona      -   Open Source Content Management   -    Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner@wyona.com                        michi@apache.org
+41 44 272 91 61


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org