You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@myfaces.apache.org by Cagatay Civici <ca...@gmail.com> on 2006/08/09 15:39:24 UTC

Site of Other Modules

Hi,

I've wanted to written a documentation for a sandbox component but could not
figure out where to begin. Building the site module only brings the main
site, not the sites of submodules likes api, impl, tomahawk, sandbox and
etc.

Where to look?

Cagatay

Re: Site of Other Modules

Posted by Mike Kienenberger <mk...@gmail.com>.
Well, all of these pages are available at http://myfaces.apache.org,
including the template :-)

http://myfaces.apache.org/tomahawk/component-template.html

But really, you need to build them locally, and you'll have local
examples of them as well.

What I recommend is using this tool to work with them.   It's a lot easier.

http://wiki.apache.org/myfaces/EditXdocs


On 8/9/06, Cagatay Civici <ca...@gmail.com> wrote:
> Hi Mike,
>
> Thanks for the info, I've done some work on sandbox site so that's the only
> one I've built locally.
>
> component-template seems to be enough for now, but maybe a link to an online
> example deployed at irian should be useful.
>
> WDYT?
>
> Cagatay
>
>
> On 8/9/06, Mike Kienenberger <mk...@gmail.com> wrote:
> > More specifically, there's the following template.   Improve it if it
> > doesn't cover all of the documentation issues.  :-)
> >
> >
> tomahawk/sandbox/core/src/site/xdoc/component-template.xml
> >
> > Not sure about the building task.   I'm pretty sure that doing a "mvn
> > site" built everything for me in the past, but it's been awhile.    I
> > would also think you do do a "mvn site" in a subproject (like sandbox)
> > to only build documentation for that part, but maybe that doesn't
> > work.
> >
> > On 8/9/06, Cagatay Civici <ca...@gmail.com> wrote:
> > > I missed that, thanks Lance
> > >
> > > On 8/9/06, L Frohman < lfrohman@gmail.com> wrote:
> > > >
> > > >
> > > >
> > > > I think it is:
> > > >
> > > >
> tomahawk/sandbox/core/src/site/xdoc/{component_name}.xml
> > > >
> > > >
> > > > ________________________________
> > >  De : Cagatay Civici [mailto:cagatay.civici@gmail.com]
> > > > Envoyé : mercredi 9 août 2006 15:39
> > > > À : MyFaces Development
> > > > Objet : Site of Other Modules
> > > >
> > > >
> > > >
> > > >
> > > > Hi,
> > > >
> > > > I've wanted to written a documentation for a sandbox component but
> could
> > > not figure out where to begin. Building the site module only brings the
> main
> > > site, not the sites of submodules likes api, impl, tomahawk, sandbox and
> > > etc.
> > > >
> > > > Where to look?
> > > >
> > > > Cagatay
> > > >
> > > >
> > > >
> > >
> > >
> >
>
>

Re: Site of Other Modules

Posted by Cagatay Civici <ca...@gmail.com>.
Hi Mike,

Thanks for the info, I've done some work on sandbox site so that's the only
one I've built locally.

component-template seems to be enough for now, but maybe a link to an online
example deployed at irian should be useful.

WDYT?

Cagatay

On 8/9/06, Mike Kienenberger <mk...@gmail.com> wrote:
>
> More specifically, there's the following template.   Improve it if it
> doesn't cover all of the documentation issues.  :-)
>
> tomahawk/sandbox/core/src/site/xdoc/component-template.xml
>
> Not sure about the building task.   I'm pretty sure that doing a "mvn
> site" built everything for me in the past, but it's been awhile.    I
> would also think you do do a "mvn site" in a subproject (like sandbox)
> to only build documentation for that part, but maybe that doesn't
> work.
>
> On 8/9/06, Cagatay Civici <ca...@gmail.com> wrote:
> > I missed that, thanks Lance
> >
> > On 8/9/06, L Frohman <lf...@gmail.com> wrote:
> > >
> > >
> > >
> > > I think it is:
> > >
> > > tomahawk/sandbox/core/src/site/xdoc/{component_name}.xml
> > >
> > >
> > > ________________________________
> >  De : Cagatay Civici [mailto:cagatay.civici@gmail.com]
> > > Envoyé : mercredi 9 août 2006 15:39
> > > À : MyFaces Development
> > > Objet : Site of Other Modules
> > >
> > >
> > >
> > >
> > > Hi,
> > >
> > > I've wanted to written a documentation for a sandbox component but
> could
> > not figure out where to begin. Building the site module only brings the
> main
> > site, not the sites of submodules likes api, impl, tomahawk, sandbox and
> > etc.
> > >
> > > Where to look?
> > >
> > > Cagatay
> > >
> > >
> > >
> >
> >
>

Re: Site of Other Modules

Posted by Mike Kienenberger <mk...@gmail.com>.
More specifically, there's the following template.   Improve it if it
doesn't cover all of the documentation issues.  :-)

tomahawk/sandbox/core/src/site/xdoc/component-template.xml

Not sure about the building task.   I'm pretty sure that doing a "mvn
site" built everything for me in the past, but it's been awhile.    I
would also think you do do a "mvn site" in a subproject (like sandbox)
to only build documentation for that part, but maybe that doesn't
work.

On 8/9/06, Cagatay Civici <ca...@gmail.com> wrote:
> I missed that, thanks Lance
>
> On 8/9/06, L Frohman <lf...@gmail.com> wrote:
> >
> >
> >
> > I think it is:
> >
> > tomahawk/sandbox/core/src/site/xdoc/{component_name}.xml
> >
> >
> > ________________________________
>  De : Cagatay Civici [mailto:cagatay.civici@gmail.com]
> > Envoyé : mercredi 9 août 2006 15:39
> > À : MyFaces Development
> > Objet : Site of Other Modules
> >
> >
> >
> >
> > Hi,
> >
> > I've wanted to written a documentation for a sandbox component but could
> not figure out where to begin. Building the site module only brings the main
> site, not the sites of submodules likes api, impl, tomahawk, sandbox and
> etc.
> >
> > Where to look?
> >
> > Cagatay
> >
> >
> >
>
>

Re: Site of Other Modules

Posted by Cagatay Civici <ca...@gmail.com>.
I missed that, thanks Lance

On 8/9/06, L Frohman <lf...@gmail.com> wrote:
>
>  I think it is:
>
> tomahawk/sandbox/core/src/site/xdoc/{component_name}.xml
>
>
>  ------------------------------
> *De :* Cagatay Civici [mailto:cagatay.civici@gmail.com]
> *Envoyé :* mercredi 9 août 2006 15:39
> *À :* MyFaces Development
> *Objet :* Site of Other Modules
>
> Hi,
>
> I've wanted to written a documentation for a sandbox component but could
> not figure out where to begin. Building the site module only brings the main
> site, not the sites of submodules likes api, impl, tomahawk, sandbox and
> etc.
>
> Where to look?
>
> Cagatay
>