You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@myfaces.apache.org by "Mike Kienenberger (JIRA)" <my...@incubator.apache.org> on 2005/07/08 21:03:13 UTC

[jira] Created: (MYFACES-316) Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs

Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs
--------------------------------------------------------------------------------

         Key: MYFACES-316
         URL: http://issues.apache.org/jira/browse/MYFACES-316
     Project: MyFaces
        Type: Task
    Versions: Nightly Build    
    Reporter: Mike Kienenberger


Migrate component documentation from marinschek.com tiki and wiki to forrest xdocs.

Sean Schofield and I wrote something along the lines of:

The component documentation should really go in the website. Install forrest and setup a FORREST_HOME environment variable (follow their instructions on that.)  Then you can checkout the "myfaces/forrest" project from SVN and build.

There is a sample component documentation that I setup (component-template.xml.)  This is the preferred way to document components.  Note that I setup a template for most components a while back (with just a bunch of to-dos.)  If you want to document one of those, please just replace with the new  forrest/content/xdocs/components/component-template.xml format.  The documentation for newspaperTable is representative of the new format.

you also need to patch forrest/content/site.xml so that the new component page shows up in
the index.  Ie, just add a

        <component-name="component-name" href="component-name.html"/>

line in site.xml at the appropriate spot.

So that work is not being duplicated, add a comment to this issue for each component that you are documenting so that someone else doesn't start working on it at the same time.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Re: [jira] Closed: (MYFACES-316) Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs

Posted by Martin Marinschek <ma...@gmail.com>.
Thanks for the offer,

the special MyFaces-feature 

displayValueOnly is not documented so far,

as well as: 

the <x:div/> tag, the <x:htmlTag /> tag, the <x:inputTextHelp /> tag,
the <x:radio /> tag and whatever else I haven't found so far ;)

regards,

Martin

On 7/9/05, Mike Kienenberger <mk...@gmail.com> wrote:
> On 7/9/05, Martin Marinschek <ma...@gmail.com> wrote:
> > I got Thomas Obereder, one of my students here, to do at least part of it...
> > he sent me the patches, so work is in progress on this.
> 
> I'm willing to do more as time permits.
> 
> Or if your student is going to finish it all off, that's fine too.
> 
> If you need me to work on it any further, just reopen the task and
> note which pieces your student plans to do.
> 
> Thanks,
> 
> -Mike
> 
>

Re: [jira] Closed: (MYFACES-316) Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs

Posted by Martin Marinschek <ma...@gmail.com>.
Well,

I got Thomas Obereder, one of my students here, to do at least part of it...

he sent me the patches, so work is in progress on this.

regards,

Martin


On 7/9/05, Mike Kienenberger <mk...@gmail.com> wrote:
> On 7/9/05, Martin Marinschek (JIRA) <my...@incubator.apache.org> wrote:
> >      [ http://issues.apache.org/jira/browse/MYFACES-316?page=all ]
> > Martin Marinschek closed MYFACES-316:
> > Thanks Mike Kienenberger for helping out, I just applied your patch.
> > > Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs
> 
> Thanks!
> 
> However, this is an ongoing task :)   I only migrated one of the pages so far.
> 
> You should probably reopen the task until they're all migrated..  :)
> 
> -Mike
>

Re: [jira] Closed: (MYFACES-316) Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs

Posted by Mike Kienenberger <mk...@gmail.com>.
On 7/9/05, Martin Marinschek (JIRA) <my...@incubator.apache.org> wrote:
>      [ http://issues.apache.org/jira/browse/MYFACES-316?page=all ]
> Martin Marinschek closed MYFACES-316:
> Thanks Mike Kienenberger for helping out, I just applied your patch.
> > Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs

Thanks!

However, this is an ongoing task :)   I only migrated one of the pages so far.

You should probably reopen the task until they're all migrated..  :)

-Mike

[jira] Closed: (MYFACES-316) Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs

Posted by "Martin Marinschek (JIRA)" <my...@incubator.apache.org>.
     [ http://issues.apache.org/jira/browse/MYFACES-316?page=all ]
     
Martin Marinschek closed MYFACES-316:
-------------------------------------

    Fix Version: Nightly Build
     Resolution: Fixed

Thanks Mike Kienenberger for helping out, I just applied your patch.

> Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs
> --------------------------------------------------------------------------------
>
>          Key: MYFACES-316
>          URL: http://issues.apache.org/jira/browse/MYFACES-316
>      Project: MyFaces
>         Type: Task
>     Versions: Nightly Build
>     Reporter: Mike Kienenberger
>     Assignee: Martin Marinschek
>      Fix For: Nightly Build
>  Attachments: datascroller.patch.txt
>
> Migrate component documentation from marinschek.com tiki and wiki to forrest xdocs.
> Sean Schofield and I wrote something along the lines of:
> The component documentation should really go in the website. Install forrest and setup a FORREST_HOME environment variable (follow their instructions on that.)  Then you can checkout the "myfaces/forrest" project from SVN and build.
> There is a sample component documentation that I setup (component-template.xml.)  This is the preferred way to document components.  Note that I setup a template for most components a while back (with just a bunch of to-dos.)  If you want to document one of those, please just replace with the new  forrest/content/xdocs/components/component-template.xml format.  The documentation for newspaperTable is representative of the new format.
> you also need to patch forrest/content/site.xml so that the new component page shows up in
> the index.  Ie, just add a
>         <component-name="component-name" href="component-name.html"/>
> line in site.xml at the appropriate spot.
> So that work is not being duplicated, add a comment to this issue for each component that you are documenting so that someone else doesn't start working on it at the same time.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Updated: (MYFACES-316) Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs

Posted by "Mike Kienenberger (JIRA)" <my...@incubator.apache.org>.
     [ http://issues.apache.org/jira/browse/MYFACES-316?page=all ]

Mike Kienenberger updated MYFACES-316:
--------------------------------------

    Attachment: datascroller.patch.txt

Well, here's a patch adding datascroller and fixing a couple of minor things for component-template.xml.

Unfortunately, my copy of  forrest 0.6 isn't working well with the myfaces/forrest directory, so I'm unable to use either "forrest site" or "forrest run" to test it.


> Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs
> --------------------------------------------------------------------------------
>
>          Key: MYFACES-316
>          URL: http://issues.apache.org/jira/browse/MYFACES-316
>      Project: MyFaces
>         Type: Task
>     Versions: Nightly Build
>     Reporter: Mike Kienenberger
>  Attachments: datascroller.patch.txt
>
> Migrate component documentation from marinschek.com tiki and wiki to forrest xdocs.
> Sean Schofield and I wrote something along the lines of:
> The component documentation should really go in the website. Install forrest and setup a FORREST_HOME environment variable (follow their instructions on that.)  Then you can checkout the "myfaces/forrest" project from SVN and build.
> There is a sample component documentation that I setup (component-template.xml.)  This is the preferred way to document components.  Note that I setup a template for most components a while back (with just a bunch of to-dos.)  If you want to document one of those, please just replace with the new  forrest/content/xdocs/components/component-template.xml format.  The documentation for newspaperTable is representative of the new format.
> you also need to patch forrest/content/site.xml so that the new component page shows up in
> the index.  Ie, just add a
>         <component-name="component-name" href="component-name.html"/>
> line in site.xml at the appropriate spot.
> So that work is not being duplicated, add a comment to this issue for each component that you are documenting so that someone else doesn't start working on it at the same time.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Commented: (MYFACES-316) Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs

Posted by "Mike Kienenberger (JIRA)" <my...@incubator.apache.org>.
    [ http://issues.apache.org/jira/browse/MYFACES-316?page=comments#action_12315341 ] 

Mike Kienenberger commented on MYFACES-316:
-------------------------------------------

I left off the URL for the tiki documentation:

http://www.marinschek.com/myfaces/tiki/tiki-index.php?page=Features

> Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs
> --------------------------------------------------------------------------------
>
>          Key: MYFACES-316
>          URL: http://issues.apache.org/jira/browse/MYFACES-316
>      Project: MyFaces
>         Type: Task
>     Versions: Nightly Build
>     Reporter: Mike Kienenberger

>
> Migrate component documentation from marinschek.com tiki and wiki to forrest xdocs.
> Sean Schofield and I wrote something along the lines of:
> The component documentation should really go in the website. Install forrest and setup a FORREST_HOME environment variable (follow their instructions on that.)  Then you can checkout the "myfaces/forrest" project from SVN and build.
> There is a sample component documentation that I setup (component-template.xml.)  This is the preferred way to document components.  Note that I setup a template for most components a while back (with just a bunch of to-dos.)  If you want to document one of those, please just replace with the new  forrest/content/xdocs/components/component-template.xml format.  The documentation for newspaperTable is representative of the new format.
> you also need to patch forrest/content/site.xml so that the new component page shows up in
> the index.  Ie, just add a
>         <component-name="component-name" href="component-name.html"/>
> line in site.xml at the appropriate spot.
> So that work is not being duplicated, add a comment to this issue for each component that you are documenting so that someone else doesn't start working on it at the same time.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira