You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Vincent Massol <vm...@pivolis.com> on 2003/06/06 13:00:50 UTC
Maven web site and Wiki
Hi,
Here are some facts:
- Our Maven web site contains lots of inaccuracies and would not suffer
from additional documentation
- Some Maven users would be happy to contribute if we gave them easy
tools for that.
The idea:
- Transform our web site from a static web site into a Wiki web site.
- But not any wiki! One that saves topics in XML format. For example the
MoinMoin wiki saves topic in xdocs format (stylebook style unfortunately
but that's not too far from our xdocs format and could probably be
easily modified )
- Second step: hook the wiki to CVS so that modifications are saved in
our Maven CVS, directly in xdocs format. This is possible with MoinMoin
and probably with others too.
- Note: The MoinMoin wiki also has a "comment" field that could be used
as the CVS commit message. We could force the need to have a non-blank
text if we wish to make sure there are commit messages.
- We get automatically CVS email notifications whenever pages are
modified and we can thus easily control the changes made to the wiki and
correct when and if needed.
Conclusion:
- We keep the advantage of our xdocs
- We can still edit xdocs directly should we wish
- Anyone can contribute easily to the documentation and we get good and
up to date Maven documentation.
If we agree, there are things to do:
- We need to find a machine where the wiki could run (it could be a
machine provided by a Friend Of Maven or an Apache one if there's one
available)
- We need someone to look at MoinMoin (or another wiki) to perform the
following:
- find how to hook it to CVS
- find how to change the default style to be the Maven style
(stylesheet)
- find how to modify the DTD so that the xdocs are in the Maven xdocs
format
- find how to define where xdocs are saved in CVS so that we try to
match the existing locations of xdocs
- We need a Wiki admin
What do you think?
Thanks
-Vincent
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
RE: Maven web site and Wiki
Posted by Vincent Massol <vm...@pivolis.com>.
Hi Brian,
> -----Original Message-----
> From: Brian Ewins [mailto:Brian.Ewins@i-documentsystems.com]
> Sent: 06 June 2003 15:20
> To: Maven Developers List
> Subject: Re: Maven web site and Wiki
>
> Vincent, are you just guessing that MoinMoin stores in xdoc format?
>
nope... check:
Rendered page:
http://www.mockobjects.com/wiki
XML view:
http://www.mockobjects.com/wiki/FrontPage?action=format&mimetype=text/xm
l
This looks very very similar the old stylebook xdoc format to me.
>
<http://twistedmatrix.com/users/jh.twistd/moin/moin.cgi/MoinDev_2fStorag
e>
> Section 1.3, Pages:
> "The pages are store exactly as they appear in the edit window in text
> format."
>
> (actually this isn't entirely true. I read the code for Page.py and it
> supports loading xml files too; however the default is plain text, and
> theres nothing in there resembling xdoc that I could see)
>
> I've written a few wikis in the past and what MoinMoin are doing is
far
> far easier than attempting to alter the edit-view of the page for
> storage (or, like UseModWiki, just serialize the in-memory page
> structure to disk). If you stored xdoc, and the xdocs could be edited
> directly as you describe, you'd need to implement round-tripping from
> xdoc to wiki markup and back again. Wiki markup isn't particularly
> expressive, I'd be surprised if this could be done well.
Maybe moinmoin stores as text (I haven't even looked at moinmoin
documentation) but with the "action" attribute it is possible to tell it
to transform it in xdocs, so I guess a hook could be used to format
after each edit and store the xml to cvs?
Thanks
-Vincent
>
> - Baz
>
> Vincent Massol wrote:
>
> >
> >>-----Original Message-----
> >>From: Cocell | Trygve Laugstøl [mailto:trygve@cocell.com]
> >>Sent: 06 June 2003 14:13
> >>To: Maven Developers List
> >>Subject: Re: Maven web site and Wiki
> >>
> >>Wasnt the point to have a wiki site and then create the xdocs based
on
> >
> > the
> >
> >>wiki site?
> >
> >
> > Nope :-) The wiki automatically saves the topics in xdocs format and
in
> > CVS!
> >
> >
> >>If the wiki site cant commit the wiki entries as xdoc formatted docs
> >
> > in
> >
> >>the
> >>maven cvs, but can export the entries as xml I think wath I proposed
> >
> > would
> >
> >>be
> >>a rather simple solution. Its just a suggestion anyway, im not
> >
> > enlightned
> >
> >>with
> >>the inner workings of wiki sites.
> >
> >
> > Oh sure, but it would be much much easier to have the wiki directly
save
> > as xdocs (such as what moinmoin does by default).
> >
> > -Vincent
> >
> >
> >>Trygve
> >>
> >>Vincent Massol wrote:
> >>
> >>>>-----Original Message-----
> >>>>From: Cocell | Trygve Laugstøl [mailto:trygve@cocell.com]
> >>>>Sent: 06 June 2003 13:52
> >>>>To: Maven Developers List
> >>>>Subject: Re: Maven web site and Wiki
> >>>>
> >>>>Hi
> >>>>
> >>>>Sounds like a really good plan, but perhaps there should be
> >
> > installed a
> >
> >>>>normal wiki installation that can deliver xml exports.
> >>>>
> >>>>Then a nighly cronjob could do this
> >>>>1. Export the new/updated entries to a xml file
> >>>>2. Use XSLT to transform the wiki xml to xdoc.
> >>>>3. Use XSLT to take out the commend field and commit it into cvs
> >>>>
> >>>>This way all that needs to be done is to write two rather simple
xsl
> >>>>tranformation sheets and the existing cvs mails will tell us about
> >
> > the
> >
> >>>>updates.
> >>>
> >>>
> >>>Why would you need to do all that? That is automatically done on
the
> >
> > fly
> >
> >>>when you edit topics in the wiki...
> >>>
> >>>Have a look at: http://www.mockobjects.com/wiki/
> >>>Here is an example of the generated XML :
> >>>
> >
> >
http://www.mockobjects.com/wiki/FrontPage?action=format&mimetype=text/xm
> >
> >>>l
> >>>(you might need to do a "view source" with IE).
> >>>
> >>>-Vincent
> >>>
> >>>
> >>>
> >>>>Trygve
> >>>>
> >>>>Vincent Massol wrote:
> >>>>
> >>>>
> >>>>>Hi,
> >>>>>
> >>>>>Here are some facts:
> >>>>>- Our Maven web site contains lots of inaccuracies and would not
> >
> > suffer
> >
> >>>>>from additional documentation
> >>>>
> >>>>>- Some Maven users would be happy to contribute if we gave them
> >
> > easy
> >
> >>>>>tools for that.
> >>>>>
> >>>>>The idea:
> >>>>>
> >>>>>- Transform our web site from a static web site into a Wiki web
> >
> > site.
> >
> >>>>>- But not any wiki! One that saves topics in XML format. For
> >
> > example
> >
> >>the
> >>
> >>>>>MoinMoin wiki saves topic in xdocs format (stylebook style
> >>
> >>unfortunately
> >>
> >>>>>but that's not too far from our xdocs format and could probably
be
> >>>>>easily modified )
> >>>>>- Second step: hook the wiki to CVS so that modifications are
saved
> >
> > in
> >
> >>>>>our Maven CVS, directly in xdocs format. This is possible with
> >
> > MoinMoin
> >
> >>>>>and probably with others too.
> >>>>>- Note: The MoinMoin wiki also has a "comment" field that could
be
> >
> > used
> >
> >>>>>as the CVS commit message. We could force the need to have a
> >
> > non-blank
> >
> >>>>>text if we wish to make sure there are commit messages.
> >>>>>- We get automatically CVS email notifications whenever pages are
> >>>>>modified and we can thus easily control the changes made to the
> >
> > wiki
> >
> >>and
> >>
> >>>>>correct when and if needed.
> >>>>>
> >>>>>Conclusion:
> >>>>>- We keep the advantage of our xdocs
> >>>>>- We can still edit xdocs directly should we wish
> >>>>>- Anyone can contribute easily to the documentation and we get
good
> >
> > and
> >
> >>>>>up to date Maven documentation.
> >>>>>
> >>>>>If we agree, there are things to do:
> >>>>>- We need to find a machine where the wiki could run (it could be
a
> >>>>>machine provided by a Friend Of Maven or an Apache one if there's
> >
> > one
> >
> >>>>>available)
> >>>>>- We need someone to look at MoinMoin (or another wiki) to
perform
> >
> > the
> >
> >>>>>following:
> >>>>> - find how to hook it to CVS
> >>>>> - find how to change the default style to be the Maven style
> >>>>>(stylesheet)
> >>>>> - find how to modify the DTD so that the xdocs are in the Maven
> >
> > xdocs
> >
> >>>>>format
> >>>>> - find how to define where xdocs are saved in CVS so that we try
> >
> > to
> >
> >>>>>match the existing locations of xdocs
> >>>>>- We need a Wiki admin
> >>>>>
> >>>>>What do you think?
> >>>>>
> >>>>>Thanks
> >>>>>-Vincent
> >>>>>
> >>>>>
> >>>>>
> >>>
> >>>
> >
---------------------------------------------------------------------
> >
> >>>>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>>>>For additional commands, e-mail: dev-help@maven.apache.org
> >>>>>
> >>>>>
> >>>>>
> >>>>
> >>>>
>
>>>---------------------------------------------------------------------
> >>>
> >>>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>>>For additional commands, e-mail: dev-help@maven.apache.org
> >>>
> >>>
> >>>
> >>>
> >>>
> >
---------------------------------------------------------------------
> >
> >>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>>For additional commands, e-mail: dev-help@maven.apache.org
> >>>
> >>>
> >>>
> >>
> >>
>
>>---------------------------------------------------------------------
> >>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
> >
> >
> >
---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> >
>
>
>
> Privacy and Confidentiality Notice
>
> ------------------------------------------------
>
> The information contained in this E-Mail message is intended only for
the
> person or persons to whom it is addressed. Such information is
> confidential and privileged and no mistake in transmission is intended
to
> waive or compromise such privilege. If you have received it in error,
> please destroy it and notify us on the telephone number printed above.
If
> you do not receive complete and legible copies, please telephone us
> immediately. Any opinions expressed herein including attachments are
those
> of the author only. i-documentsystems Ltd. does not accept
responsibility
> for the accuracy or completeness of the information provided or for
any
> changes to this Email, however made, after it was sent. (Please note
that
> it is your responsibility to scan this message for viruses).
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven web site and Wiki
Posted by Brian Ewins <Br...@i-documentsystems.com>.
Vincent, are you just guessing that MoinMoin stores in xdoc format?
<http://twistedmatrix.com/users/jh.twistd/moin/moin.cgi/MoinDev_2fStorage>
Section 1.3, Pages:
"The pages are store exactly as they appear in the edit window in text
format."
(actually this isn't entirely true. I read the code for Page.py and it
supports loading xml files too; however the default is plain text, and
theres nothing in there resembling xdoc that I could see)
I've written a few wikis in the past and what MoinMoin are doing is far
far easier than attempting to alter the edit-view of the page for
storage (or, like UseModWiki, just serialize the in-memory page
structure to disk). If you stored xdoc, and the xdocs could be edited
directly as you describe, you'd need to implement round-tripping from
xdoc to wiki markup and back again. Wiki markup isn't particularly
expressive, I'd be surprised if this could be done well.
- Baz
Vincent Massol wrote:
>
>>-----Original Message-----
>>From: Cocell | Trygve Laugstøl [mailto:trygve@cocell.com]
>>Sent: 06 June 2003 14:13
>>To: Maven Developers List
>>Subject: Re: Maven web site and Wiki
>>
>>Wasnt the point to have a wiki site and then create the xdocs based on
>
> the
>
>>wiki site?
>
>
> Nope :-) The wiki automatically saves the topics in xdocs format and in
> CVS!
>
>
>>If the wiki site cant commit the wiki entries as xdoc formatted docs
>
> in
>
>>the
>>maven cvs, but can export the entries as xml I think wath I proposed
>
> would
>
>>be
>>a rather simple solution. Its just a suggestion anyway, im not
>
> enlightned
>
>>with
>>the inner workings of wiki sites.
>
>
> Oh sure, but it would be much much easier to have the wiki directly save
> as xdocs (such as what moinmoin does by default).
>
> -Vincent
>
>
>>Trygve
>>
>>Vincent Massol wrote:
>>
>>>>-----Original Message-----
>>>>From: Cocell | Trygve Laugstøl [mailto:trygve@cocell.com]
>>>>Sent: 06 June 2003 13:52
>>>>To: Maven Developers List
>>>>Subject: Re: Maven web site and Wiki
>>>>
>>>>Hi
>>>>
>>>>Sounds like a really good plan, but perhaps there should be
>
> installed a
>
>>>>normal wiki installation that can deliver xml exports.
>>>>
>>>>Then a nighly cronjob could do this
>>>>1. Export the new/updated entries to a xml file
>>>>2. Use XSLT to transform the wiki xml to xdoc.
>>>>3. Use XSLT to take out the commend field and commit it into cvs
>>>>
>>>>This way all that needs to be done is to write two rather simple xsl
>>>>tranformation sheets and the existing cvs mails will tell us about
>
> the
>
>>>>updates.
>>>
>>>
>>>Why would you need to do all that? That is automatically done on the
>
> fly
>
>>>when you edit topics in the wiki...
>>>
>>>Have a look at: http://www.mockobjects.com/wiki/
>>>Here is an example of the generated XML :
>>>
>
> http://www.mockobjects.com/wiki/FrontPage?action=format&mimetype=text/xm
>
>>>l
>>>(you might need to do a "view source" with IE).
>>>
>>>-Vincent
>>>
>>>
>>>
>>>>Trygve
>>>>
>>>>Vincent Massol wrote:
>>>>
>>>>
>>>>>Hi,
>>>>>
>>>>>Here are some facts:
>>>>>- Our Maven web site contains lots of inaccuracies and would not
>
> suffer
>
>>>>>from additional documentation
>>>>
>>>>>- Some Maven users would be happy to contribute if we gave them
>
> easy
>
>>>>>tools for that.
>>>>>
>>>>>The idea:
>>>>>
>>>>>- Transform our web site from a static web site into a Wiki web
>
> site.
>
>>>>>- But not any wiki! One that saves topics in XML format. For
>
> example
>
>>the
>>
>>>>>MoinMoin wiki saves topic in xdocs format (stylebook style
>>
>>unfortunately
>>
>>>>>but that's not too far from our xdocs format and could probably be
>>>>>easily modified )
>>>>>- Second step: hook the wiki to CVS so that modifications are saved
>
> in
>
>>>>>our Maven CVS, directly in xdocs format. This is possible with
>
> MoinMoin
>
>>>>>and probably with others too.
>>>>>- Note: The MoinMoin wiki also has a "comment" field that could be
>
> used
>
>>>>>as the CVS commit message. We could force the need to have a
>
> non-blank
>
>>>>>text if we wish to make sure there are commit messages.
>>>>>- We get automatically CVS email notifications whenever pages are
>>>>>modified and we can thus easily control the changes made to the
>
> wiki
>
>>and
>>
>>>>>correct when and if needed.
>>>>>
>>>>>Conclusion:
>>>>>- We keep the advantage of our xdocs
>>>>>- We can still edit xdocs directly should we wish
>>>>>- Anyone can contribute easily to the documentation and we get good
>
> and
>
>>>>>up to date Maven documentation.
>>>>>
>>>>>If we agree, there are things to do:
>>>>>- We need to find a machine where the wiki could run (it could be a
>>>>>machine provided by a Friend Of Maven or an Apache one if there's
>
> one
>
>>>>>available)
>>>>>- We need someone to look at MoinMoin (or another wiki) to perform
>
> the
>
>>>>>following:
>>>>> - find how to hook it to CVS
>>>>> - find how to change the default style to be the Maven style
>>>>>(stylesheet)
>>>>> - find how to modify the DTD so that the xdocs are in the Maven
>
> xdocs
>
>>>>>format
>>>>> - find how to define where xdocs are saved in CVS so that we try
>
> to
>
>>>>>match the existing locations of xdocs
>>>>>- We need a Wiki admin
>>>>>
>>>>>What do you think?
>>>>>
>>>>>Thanks
>>>>>-Vincent
>>>>>
>>>>>
>>>>>
>>>
>>>
> ---------------------------------------------------------------------
>
>>>>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>>>>For additional commands, e-mail: dev-help@maven.apache.org
>>>>>
>>>>>
>>>>>
>>>>
>>>>
>>>---------------------------------------------------------------------
>>>
>>>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>>>For additional commands, e-mail: dev-help@maven.apache.org
>>>
>>>
>>>
>>>
>>>
> ---------------------------------------------------------------------
>
>>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>>For additional commands, e-mail: dev-help@maven.apache.org
>>>
>>>
>>>
>>
>>
>>---------------------------------------------------------------------
>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>For additional commands, e-mail: dev-help@maven.apache.org
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
Privacy and Confidentiality Notice
------------------------------------------------
The information contained in this E-Mail message is intended only for the person or persons to whom it is addressed. Such information is confidential and privileged and no mistake in transmission is intended to waive or compromise such privilege. If you have received it in error, please destroy it and notify us on the telephone number printed above. If you do not receive complete and legible copies, please telephone us immediately. Any opinions expressed herein including attachments are those of the author only. i-documentsystems Ltd. does not accept responsibility for the accuracy or completeness of the information provided or for any changes to this Email, however made, after it was sent. (Please note that it is your responsibility to scan this message for viruses).
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
RE: Maven web site and Wiki
Posted by Vincent Massol <vm...@pivolis.com>.
> -----Original Message-----
> From: Cocell | Trygve Laugstøl [mailto:trygve@cocell.com]
> Sent: 06 June 2003 14:13
> To: Maven Developers List
> Subject: Re: Maven web site and Wiki
>
> Wasnt the point to have a wiki site and then create the xdocs based on
the
> wiki site?
Nope :-) The wiki automatically saves the topics in xdocs format and in
CVS!
>
> If the wiki site cant commit the wiki entries as xdoc formatted docs
in
> the
> maven cvs, but can export the entries as xml I think wath I proposed
would
> be
> a rather simple solution. Its just a suggestion anyway, im not
enlightned
> with
> the inner workings of wiki sites.
Oh sure, but it would be much much easier to have the wiki directly save
as xdocs (such as what moinmoin does by default).
-Vincent
>
> Trygve
>
> Vincent Massol wrote:
> >
> >>-----Original Message-----
> >>From: Cocell | Trygve Laugstøl [mailto:trygve@cocell.com]
> >>Sent: 06 June 2003 13:52
> >>To: Maven Developers List
> >>Subject: Re: Maven web site and Wiki
> >>
> >>Hi
> >>
> >>Sounds like a really good plan, but perhaps there should be
installed a
> >>normal wiki installation that can deliver xml exports.
> >>
> >>Then a nighly cronjob could do this
> >>1. Export the new/updated entries to a xml file
> >>2. Use XSLT to transform the wiki xml to xdoc.
> >>3. Use XSLT to take out the commend field and commit it into cvs
> >>
> >>This way all that needs to be done is to write two rather simple xsl
> >>tranformation sheets and the existing cvs mails will tell us about
the
> >>updates.
> >
> >
> > Why would you need to do all that? That is automatically done on the
fly
> > when you edit topics in the wiki...
> >
> > Have a look at: http://www.mockobjects.com/wiki/
> > Here is an example of the generated XML :
> >
http://www.mockobjects.com/wiki/FrontPage?action=format&mimetype=text/xm
> > l
> > (you might need to do a "view source" with IE).
> >
> > -Vincent
> >
> >
> >>Trygve
> >>
> >>Vincent Massol wrote:
> >>
> >>>Hi,
> >>>
> >>>Here are some facts:
> >>>- Our Maven web site contains lots of inaccuracies and would not
suffer
> >>>from additional documentation
> >>>- Some Maven users would be happy to contribute if we gave them
easy
> >>>tools for that.
> >>>
> >>>The idea:
> >>>
> >>>- Transform our web site from a static web site into a Wiki web
site.
> >>>- But not any wiki! One that saves topics in XML format. For
example
> the
> >>>MoinMoin wiki saves topic in xdocs format (stylebook style
> unfortunately
> >>>but that's not too far from our xdocs format and could probably be
> >>>easily modified )
> >>>- Second step: hook the wiki to CVS so that modifications are saved
in
> >>>our Maven CVS, directly in xdocs format. This is possible with
MoinMoin
> >>>and probably with others too.
> >>>- Note: The MoinMoin wiki also has a "comment" field that could be
used
> >>>as the CVS commit message. We could force the need to have a
non-blank
> >>>text if we wish to make sure there are commit messages.
> >>>- We get automatically CVS email notifications whenever pages are
> >>>modified and we can thus easily control the changes made to the
wiki
> and
> >>>correct when and if needed.
> >>>
> >>>Conclusion:
> >>>- We keep the advantage of our xdocs
> >>>- We can still edit xdocs directly should we wish
> >>>- Anyone can contribute easily to the documentation and we get good
and
> >>>up to date Maven documentation.
> >>>
> >>>If we agree, there are things to do:
> >>>- We need to find a machine where the wiki could run (it could be a
> >>>machine provided by a Friend Of Maven or an Apache one if there's
one
> >>>available)
> >>>- We need someone to look at MoinMoin (or another wiki) to perform
the
> >>>following:
> >>> - find how to hook it to CVS
> >>> - find how to change the default style to be the Maven style
> >>>(stylesheet)
> >>> - find how to modify the DTD so that the xdocs are in the Maven
xdocs
> >>>format
> >>> - find how to define where xdocs are saved in CVS so that we try
to
> >>>match the existing locations of xdocs
> >>>- We need a Wiki admin
> >>>
> >>>What do you think?
> >>>
> >>>Thanks
> >>>-Vincent
> >>>
> >>>
> >>>
> >
> >
---------------------------------------------------------------------
> >
> >>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>>For additional commands, e-mail: dev-help@maven.apache.org
> >>>
> >>>
> >>>
> >>
> >>
>
>>---------------------------------------------------------------------
> >>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
> >
> >
> >
---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven web site and Wiki
Posted by Cocell | Trygve Laugstøl <tr...@cocell.com>.
Wasnt the point to have a wiki site and then create the xdocs based on the
wiki site?
If the wiki site cant commit the wiki entries as xdoc formatted docs in the
maven cvs, but can export the entries as xml I think wath I proposed would be
a rather simple solution. Its just a suggestion anyway, im not enlightned with
the inner workings of wiki sites.
Trygve
Vincent Massol wrote:
>
>>-----Original Message-----
>>From: Cocell | Trygve Laugstøl [mailto:trygve@cocell.com]
>>Sent: 06 June 2003 13:52
>>To: Maven Developers List
>>Subject: Re: Maven web site and Wiki
>>
>>Hi
>>
>>Sounds like a really good plan, but perhaps there should be installed a
>>normal wiki installation that can deliver xml exports.
>>
>>Then a nighly cronjob could do this
>>1. Export the new/updated entries to a xml file
>>2. Use XSLT to transform the wiki xml to xdoc.
>>3. Use XSLT to take out the commend field and commit it into cvs
>>
>>This way all that needs to be done is to write two rather simple xsl
>>tranformation sheets and the existing cvs mails will tell us about the
>>updates.
>
>
> Why would you need to do all that? That is automatically done on the fly
> when you edit topics in the wiki...
>
> Have a look at: http://www.mockobjects.com/wiki/
> Here is an example of the generated XML :
> http://www.mockobjects.com/wiki/FrontPage?action=format&mimetype=text/xm
> l
> (you might need to do a "view source" with IE).
>
> -Vincent
>
>
>>Trygve
>>
>>Vincent Massol wrote:
>>
>>>Hi,
>>>
>>>Here are some facts:
>>>- Our Maven web site contains lots of inaccuracies and would not suffer
>>>from additional documentation
>>>- Some Maven users would be happy to contribute if we gave them easy
>>>tools for that.
>>>
>>>The idea:
>>>
>>>- Transform our web site from a static web site into a Wiki web site.
>>>- But not any wiki! One that saves topics in XML format. For example the
>>>MoinMoin wiki saves topic in xdocs format (stylebook style unfortunately
>>>but that's not too far from our xdocs format and could probably be
>>>easily modified )
>>>- Second step: hook the wiki to CVS so that modifications are saved in
>>>our Maven CVS, directly in xdocs format. This is possible with MoinMoin
>>>and probably with others too.
>>>- Note: The MoinMoin wiki also has a "comment" field that could be used
>>>as the CVS commit message. We could force the need to have a non-blank
>>>text if we wish to make sure there are commit messages.
>>>- We get automatically CVS email notifications whenever pages are
>>>modified and we can thus easily control the changes made to the wiki and
>>>correct when and if needed.
>>>
>>>Conclusion:
>>>- We keep the advantage of our xdocs
>>>- We can still edit xdocs directly should we wish
>>>- Anyone can contribute easily to the documentation and we get good and
>>>up to date Maven documentation.
>>>
>>>If we agree, there are things to do:
>>>- We need to find a machine where the wiki could run (it could be a
>>>machine provided by a Friend Of Maven or an Apache one if there's one
>>>available)
>>>- We need someone to look at MoinMoin (or another wiki) to perform the
>>>following:
>>> - find how to hook it to CVS
>>> - find how to change the default style to be the Maven style
>>>(stylesheet)
>>> - find how to modify the DTD so that the xdocs are in the Maven xdocs
>>>format
>>> - find how to define where xdocs are saved in CVS so that we try to
>>>match the existing locations of xdocs
>>>- We need a Wiki admin
>>>
>>>What do you think?
>>>
>>>Thanks
>>>-Vincent
>>>
>>>
>>>
>
> ---------------------------------------------------------------------
>
>>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>>For additional commands, e-mail: dev-help@maven.apache.org
>>>
>>>
>>>
>>
>>
>>---------------------------------------------------------------------
>>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>For additional commands, e-mail: dev-help@maven.apache.org
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
RE: Maven web site and Wiki
Posted by Vincent Massol <vm...@pivolis.com>.
> -----Original Message-----
> From: Cocell | Trygve Laugstøl [mailto:trygve@cocell.com]
> Sent: 06 June 2003 13:52
> To: Maven Developers List
> Subject: Re: Maven web site and Wiki
>
> Hi
>
> Sounds like a really good plan, but perhaps there should be installed
a
> normal wiki installation that can deliver xml exports.
>
> Then a nighly cronjob could do this
> 1. Export the new/updated entries to a xml file
> 2. Use XSLT to transform the wiki xml to xdoc.
> 3. Use XSLT to take out the commend field and commit it into cvs
>
> This way all that needs to be done is to write two rather simple xsl
> tranformation sheets and the existing cvs mails will tell us about the
> updates.
Why would you need to do all that? That is automatically done on the fly
when you edit topics in the wiki...
Have a look at: http://www.mockobjects.com/wiki/
Here is an example of the generated XML :
http://www.mockobjects.com/wiki/FrontPage?action=format&mimetype=text/xm
l
(you might need to do a "view source" with IE).
-Vincent
>
> Trygve
>
> Vincent Massol wrote:
> > Hi,
> >
> > Here are some facts:
> > - Our Maven web site contains lots of inaccuracies and would not
suffer
> > from additional documentation
> > - Some Maven users would be happy to contribute if we gave them easy
> > tools for that.
> >
> > The idea:
> >
> > - Transform our web site from a static web site into a Wiki web
site.
> > - But not any wiki! One that saves topics in XML format. For example
the
> > MoinMoin wiki saves topic in xdocs format (stylebook style
unfortunately
> > but that's not too far from our xdocs format and could probably be
> > easily modified )
> > - Second step: hook the wiki to CVS so that modifications are saved
in
> > our Maven CVS, directly in xdocs format. This is possible with
MoinMoin
> > and probably with others too.
> > - Note: The MoinMoin wiki also has a "comment" field that could be
used
> > as the CVS commit message. We could force the need to have a
non-blank
> > text if we wish to make sure there are commit messages.
> > - We get automatically CVS email notifications whenever pages are
> > modified and we can thus easily control the changes made to the wiki
and
> > correct when and if needed.
> >
> > Conclusion:
> > - We keep the advantage of our xdocs
> > - We can still edit xdocs directly should we wish
> > - Anyone can contribute easily to the documentation and we get good
and
> > up to date Maven documentation.
> >
> > If we agree, there are things to do:
> > - We need to find a machine where the wiki could run (it could be a
> > machine provided by a Friend Of Maven or an Apache one if there's
one
> > available)
> > - We need someone to look at MoinMoin (or another wiki) to perform
the
> > following:
> > - find how to hook it to CVS
> > - find how to change the default style to be the Maven style
> > (stylesheet)
> > - find how to modify the DTD so that the xdocs are in the Maven
xdocs
> > format
> > - find how to define where xdocs are saved in CVS so that we try
to
> > match the existing locations of xdocs
> > - We need a Wiki admin
> >
> > What do you think?
> >
> > Thanks
> > -Vincent
> >
> >
> >
---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven web site and Wiki
Posted by Cocell | Trygve Laugstøl <tr...@cocell.com>.
Hi
Sounds like a really good plan, but perhaps there should be installed a
normal wiki installation that can deliver xml exports.
Then a nighly cronjob could do this
1. Export the new/updated entries to a xml file
2. Use XSLT to transform the wiki xml to xdoc.
3. Use XSLT to take out the commend field and commit it into cvs
This way all that needs to be done is to write two rather simple xsl
tranformation sheets and the existing cvs mails will tell us about the updates.
Trygve
Vincent Massol wrote:
> Hi,
>
> Here are some facts:
> - Our Maven web site contains lots of inaccuracies and would not suffer
> from additional documentation
> - Some Maven users would be happy to contribute if we gave them easy
> tools for that.
>
> The idea:
>
> - Transform our web site from a static web site into a Wiki web site.
> - But not any wiki! One that saves topics in XML format. For example the
> MoinMoin wiki saves topic in xdocs format (stylebook style unfortunately
> but that's not too far from our xdocs format and could probably be
> easily modified )
> - Second step: hook the wiki to CVS so that modifications are saved in
> our Maven CVS, directly in xdocs format. This is possible with MoinMoin
> and probably with others too.
> - Note: The MoinMoin wiki also has a "comment" field that could be used
> as the CVS commit message. We could force the need to have a non-blank
> text if we wish to make sure there are commit messages.
> - We get automatically CVS email notifications whenever pages are
> modified and we can thus easily control the changes made to the wiki and
> correct when and if needed.
>
> Conclusion:
> - We keep the advantage of our xdocs
> - We can still edit xdocs directly should we wish
> - Anyone can contribute easily to the documentation and we get good and
> up to date Maven documentation.
>
> If we agree, there are things to do:
> - We need to find a machine where the wiki could run (it could be a
> machine provided by a Friend Of Maven or an Apache one if there's one
> available)
> - We need someone to look at MoinMoin (or another wiki) to perform the
> following:
> - find how to hook it to CVS
> - find how to change the default style to be the Maven style
> (stylesheet)
> - find how to modify the DTD so that the xdocs are in the Maven xdocs
> format
> - find how to define where xdocs are saved in CVS so that we try to
> match the existing locations of xdocs
> - We need a Wiki admin
>
> What do you think?
>
> Thanks
> -Vincent
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org