You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by Thorsten Scherler <th...@apache.org> on 2005/06/29 10:07:27 UTC
ASF Standard for site.xml aka sitetree.xml (was Re: Eclipse based
site.xml editor)
On Wed, 2005-06-29 at 08:43 +0200, Nicola Ken Barozzi wrote:
> Ross Gardler wrote:
> > Gregor J. Rothfuss wrote:
> >
> >> Ross Gardler wrote:
> >>
> >>> Well, in that case I would avoid EMF for this instance and we need
> >>> not consider whether site.xml is to have a DTD or not. Just a tree
> >>> editor with configurable properties on each node will do just fine.
> >>
> >> the completely free-form site.xml where each node can have pretty much
> >> any element name doesn't lend itself to a schema / DTD easily. maybe
> >> it would be useful to revisit that decision and switch to a system
> >> where you have
> >>
> >> <node id="uniqueid" href="index.html" label="About"/>
> >>
> >> this would also enforce that each node has a unique id and is
> >> therefore addressable by site:uniqueid
> >>
> >> WDYT?
> >
> > I think we discussed this to death already ;-)
> >
> > There are good reasons for us not doing that (all related to the site:
> > protocol if I remember correctly). There have been a few proposals for a
> > DTD but none have had a strong enough use case to warrant us disabling
> > the site: protocol. The current practice is that if we need a valid site
> > structure document then we simply create a internal plugin (like the
> > IMSManifest plugin) for it.
> >
> > Of course, no such decision is ever final. If someone wants to go
> > through the archives and make a new proposal we'll consider it.
>
> Ok, here it comes :-)
>
> One thing is the *internal* representation, that must be kept as now
> because of the way the site: protocol works. But this does not mean that
> we cannot decide to make the _default_ external representation be different.
>
> Personally, I would support we change the default external
> representation to something akin to what Gregor proposes, and in
> particular the same as the Lenya one.
>
> I would be even more supportive if Lenya and Cocoon adopt the Maven one,
> so that we would have a single format for all these projects.
>
You mean http://maven.apache.org/maven2/site.html ?
The section "Creating a Site Descriptor" has an example.
salu2
--
thorsten
"Together we stand, divided we fall!"
Hey you (Pink Floyd)
Re: ASF Standard for site.xml aka sitetree.xml
Posted by Nicola Ken Barozzi <ni...@apache.org>.
Gregor J. Rothfuss wrote:
...
> i suppose you could do:
>
> <menu name="Maven 2.0">
> <!-- this is the menu -->
> <item id="intro" name="Introduction" href="index.html"/>
> <item id="download" name="Download" href="download/">
> <item id="1-4" name="1.4" href="1.4.html">
> <item xml:lang="en" id="1-2" name="1.2" href="1.2.en.html">
> <item xml:lang="de" id="1-2" name="1.2" href="1.2.de.html">
> <item visibleinnav="false" name="Road Map" href="roadmap.html" />
> </menu>
>
> in essence, augment the maven format with additional attributes as
> required.
Yes, that's it :-)
Just one thing: visibleinnav="false"... in Forrest we just delete the
@name to make it invisible...
> i suppose maven does not validate site.xml?
That's not so important, as they could do so easily if they want to be
able to render Forrest or Lenya sites. The goal is to not make a
completely different format just for the sake of it.
In any case, xml-lang is another namespace, and the id IIRC can always
be there, so probably it would still validate.
--
Nicola Ken Barozzi nicolaken@apache.org
- verba volant, scripta manent -
(discussions get forgotten, just code remains)
---------------------------------------------------------------------
Re: ASF Standard for site.xml aka sitetree.xml
Posted by "Gregor J. Rothfuss" <gr...@apache.org>.
Nicola Ken Barozzi wrote:
>>> I would be even more supportive if Lenya and Cocoon adopt the Maven one,
>>> so that we would have a single format for all these projects.
>> You mean http://maven.apache.org/maven2/site.html ?
> And here is how we could do it instead:
>
> <?xml version="1.0" encoding="ISO-8859-1"?>
> <project name="Maven">
> <body>
> <links>
> <!-- these are the tabs -->
>
> <item id="apache" name="Apache" href="http://www.apache.org/" />
> <item name="Maven 1.0" href="http://maven.apache.org/"/>
> </links>
>
> <menu name="Maven 2.0">
> <!-- this is the menu -->
>
> <item id="intro" name="Introduction" href="index.html"/>
> <item id="download" name="Download" href="download.html"/>
> <item name="Road Map" href="roadmap.html" />
> </menu>
>
> ...
> </body>
> </project>
that in itself would not be sufficient. i suppose you could do:
<menu name="Maven 2.0">
<!-- this is the menu -->
<item id="intro" name="Introduction" href="index.html"/>
<item id="download" name="Download" href="download/">
<item id="1-4" name="1.4" href="1.4.html">
<item xml:lang="en" id="1-2" name="1.2" href="1.2.en.html">
<item xml:lang="de" id="1-2" name="1.2" href="1.2.de.html">
<item visibleinnav="false" name="Road Map" href="roadmap.html" />
</menu>
in essence, augment the maven format with additional attributes as
required. i suppose maven does not validate site.xml?
Re: ASF Standard for site.xml aka sitetree.xml (was Re: Eclipse based
site.xml editor)
Posted by Nicola Ken Barozzi <ni...@apache.org>.
Thorsten Scherler wrote:
> On Wed, 2005-06-29 at 08:43 +0200, Nicola Ken Barozzi wrote:
...
>>I would be even more supportive if Lenya and Cocoon adopt the Maven one,
>>so that we would have a single format for all these projects.
>
> You mean http://maven.apache.org/maven2/site.html ?
>
> The section "Creating a Site Descriptor" has an example.
Yes, although we don't need to use all tags and can add others if we
wish so.
Here is the example:
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven">
<bannerLeft>
<name>Maven</name>
<src>http://maven.apache.org/images/apache-maven-project.png</src>
<href>http://maven.apache.org/</href>
</bannerLeft>
<bannerRight>
<src>http://maven.apache.org/images/maven-small.gif</src>
</bannerRight>
<body>
<links>
<item name="Apache" href="http://www.apache.org/" />
<item name="Maven 1.0" href="http://maven.apache.org/"/>
<item name="Maven 2" href="http://maven.apache.org/maven2/"/>
</links>
<menu name="Maven 2.0">
<item name="Introduction" href="index.html"/>
<item name="Download" href="download.html"/>
<item name="Release Notes" href="release-notes.html" />
<item name="General Information" href="about.html"/>
<item name="For Maven 1.0 Users" href="maven1.html"/>
<item name="Road Map" href="roadmap.html" />
</menu>
${reports}
...
</body>
</project>
And here is how we could do it instead:
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven">
<body>
<links>
<!-- these are the tabs -->
<item id="apache" name="Apache" href="http://www.apache.org/" />
<item name="Maven 1.0" href="http://maven.apache.org/"/>
<item name="Maven 2" href="http://maven.apache.org/maven2/"/>
</links>
<menu name="Maven 2.0">
<!-- this is the menu -->
<item id="intro" name="Introduction" href="index.html"/>
<item id="download" name="Download" href="download.html"/>
<item name="Release Notes" href="release-notes.html" />
<item name="General Information" href="about.html"/>
<item name="For Maven 1.0 Users" href="maven1.html"/>
<item name="Road Map" href="roadmap.html" />
</menu>
...
</body>
</project>
--
Nicola Ken Barozzi nicolaken@apache.org
- verba volant, scripta manent -
(discussions get forgotten, just code remains)
---------------------------------------------------------------------
Re: ASF Standard for site.xml aka sitetree.xml (was Re: Eclipse based
site.xml editor)
Posted by Ross Gardler <rg...@apache.org>.
Thorsten Scherler wrote:
> On Wed, 2005-06-29 at 08:43 +0200, Nicola Ken Barozzi wrote:
>
>>Ross Gardler wrote:
>>
>>>Gregor J. Rothfuss wrote:
>>>
>>>
>>>>Ross Gardler wrote:
...
>>>> The current practice is that if we need a valid site
>>>structure document then we simply create a internal plugin (like the
>>>IMSManifest plugin) for it.
...
>>I would be even more supportive if Lenya and Cocoon adopt the Maven one,
>>so that we would have a single format for all these projects.
If you want any site navigation format other than site.xml then simply
write an Internal plugin for it. To see how see the IMSManifest plugin.
There is no need for discussion since the plugin will be entirely optional.
Speaking personally I have no use cases that are not well supported by
one of the two existing options. IMS Manifest is extremely powerful and
is a standard, site.xml is extremely simple and flexible, as well as
offering things like site: and ext:
If someone implements a new site structure plugin then we can talk about
making it "the standard", but until then discussion is pointless, we've
done it many times before. The conclusion was always "yeah there are
some good reasons to change and some good reasons not to change", nobody
has yet had a strong enough itch to build the alternative plugins. I
encourage someone to do that, lets increase the options.
For Anils work he needs to get started so I think it is best he builds
the site.xml editor. We can always change the XML structure it outputs
at a later date if necessary.
Ross
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org