[Plone-docs] collective.xdv documentation

[Anne Bowtell]

Apologies for cross-posting, I asked this question originally on the
Deliverance discussion list but it probably as much belongs here. I'm
interested to know opinions on where collective.xdv theming
documentation should live - given that it now has an entry in the add-on
products section of plone.org.

In the docs section of plone.org, we've got Alex Limi's manual - which,
although about rules-based theming in general is really an introduction
to collective.xdv. We've also got Deny's more advanced XDV tutorial
which is currently in the knowledge-base.

My question is really about Limi's manual. In the docs re-organization
this got absorbed into the core, into the theme reference manual - but
possibly this wasn't the right thing to do - it isn't really core yet
(PloneFormGen for instance which would be a comparable 'must have' is
documented in its product area).

Should we move Alex Limi's manual to the documentation area of the
collective.xdv product? (we would need some kind of redirect to be sure
that the link in Veda's book didn't break). In my view the theme
reference manual should simply have, at the moment, a review of the
principles of rule-based theming and directions to where the
documentation on collective.xdv, xdv and Deliverance can be found.

I'm very happy to help to keep it up-to-date where-ever it lives, but -
to be honest, with my current workload, I'm struggling to catch up with
Plone 4 in the theme reference manual as a whole. So it might have more
of a chance outside of the core docs area.

Any thoughts?

Anne

[Veda Williams]

I'd vote to roll it in to the collective.xdv product space and just include
a page that links to that.

Post by Anne Bowtell
Apologies for cross-posting, I asked this question originally on the
Deliverance discussion list but it probably as much belongs here. I'm
interested to know opinions on where collective.xdv theming
documentation should live - given that it now has an entry in the add-on
products section of plone.org.
In the docs section of plone.org, we've got Alex Limi's manual - which,
although about rules-based theming in general is really an introduction
to collective.xdv. We've also got Deny's more advanced XDV tutorial
which is currently in the knowledge-base.
My question is really about Limi's manual. In the docs re-organization
this got absorbed into the core, into the theme reference manual - but
possibly this wasn't the right thing to do - it isn't really core yet
(PloneFormGen for instance which would be a comparable 'must have' is
documented in its product area).
Should we move Alex Limi's manual to the documentation area of the
collective.xdv product? (we would need some kind of redirect to be sure
that the link in Veda's book didn't break). In my view the theme
reference manual should simply have, at the moment, a review of the
principles of rule-based theming and directions to where the
documentation on collective.xdv, xdv and Deliverance can be found.
I'm very happy to help to keep it up-to-date where-ever it lives, but -
to be honest, with my current workload, I'm struggling to catch up with
Plone 4 in the theme reference manual as a whole. So it might have more
of a chance outside of the core docs area.
Any thoughts?
Anne
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

--
Veda Williams
Web Developer
Groundwire
206.286.1235x23
***@groundwire.org
http://groundwire.org

ONE/Northwest is now Groundwire!

[Alexander Limi]

In my (admittedly biased ;) opinion, theming is one of the things that
should possibly live outside of the "developer manual".

The goal of xdv and why we want to transition to it is that people should
need to have very minimal (ideally none at all!) knowledge of Plone, but
still be able to put a new look on a Plone site.

Having it as chapter N in a developer manual instead of a standalone manual
will make it less visible. Since they have two different core audiences, I'd
say that it's one of the manuals that it would make sense to put it on the
top level.

Of course, this is my opinion, doc team makes final call, etc, etc. :)

— Alexander

Post by Anne Bowtell
Apologies for cross-posting, I asked this question originally on the
Deliverance discussion list but it probably as much belongs here. I'm
interested to know opinions on where collective.xdv theming documentation
should live - given that it now has an entry in the add-on products section
of plone.org.
In the docs section of plone.org, we've got Alex Limi's manual - which,
although about rules-based theming in general is really an introduction
to collective.xdv. We've also got Deny's more advanced XDV tutorial
which is currently in the knowledge-base.
My question is really about Limi's manual. In the docs re-organization
this got absorbed into the core, into the theme reference manual - but
possibly this wasn't the right thing to do - it isn't really core yet
(PloneFormGen for instance which would be a comparable 'must have' is
documented in its product area).
Should we move Alex Limi's manual to the documentation area of the
collective.xdv product? (we would need some kind of redirect to be sure
that the link in Veda's book didn't break). In my view the theme
reference manual should simply have, at the moment, a review of the
principles of rule-based theming and directions to where the
documentation on collective.xdv, xdv and Deliverance can be found.
I'm very happy to help to keep it up-to-date where-ever it lives, but -
to be honest, with my current workload, I'm struggling to catch up with
Plone 4 in the theme reference manual as a whole. So it might have more
of a chance outside of the core docs area.
Any thoughts?
Anne
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the
business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Anne Bowtell]

I'm definitely for the theming manual being separate from the
developer's manual. More a question of whether collective.xdv - as an
aspect of theming, should be part of our core set of reference manuals
or should live outside of the core since for the moment it is an
optional add-on (as for instance PloneFormGen documentation does).

Anne

Post by Alexander Limi
In my (admittedly biased ;) opinion, theming is one of the things that
should possibly live outside of the "developer manual".
The goal of xdv and why we want to transition to it is that people
should need to have very minimal (ideally none at all!) knowledge of
Plone, but still be able to put a new look on a Plone site.
Having it as chapter N in a developer manual instead of a standalone
manual will make it less visible. Since they have two different core
audiences, I'd say that it's one of the manuals that it would make
sense to put it on the top level.
Of course, this is my opinion, doc team makes final call, etc, etc. :)
— Alexander
Apologies for cross-posting, I asked this question originally on
the Deliverance discussion list but it probably as much belongs
here. I'm interested to know opinions on where collective.xdv
theming documentation should live - given that it now has an entry
in the add-on products section of plone.org <http://plone.org>.
In the docs section of plone.org <http://plone.org>, we've got
Alex Limi's manual - which,
although about rules-based theming in general is really an
introduction
to collective.xdv. We've also got Deny's more advanced XDV tutorial
which is currently in the knowledge-base.
My question is really about Limi's manual. In the docs re-organization
this got absorbed into the core, into the theme reference manual - but
possibly this wasn't the right thing to do - it isn't really core yet
(PloneFormGen for instance which would be a comparable 'must have' is
documented in its product area).
Should we move Alex Limi's manual to the documentation area of the
collective.xdv product? (we would need some kind of redirect to be sure
that the link in Veda's book didn't break). In my view the theme
reference manual should simply have, at the moment, a review of the
principles of rule-based theming and directions to where the
documentation on collective.xdv, xdv and Deliverance can be found.
I'm very happy to help to keep it up-to-date where-ever it lives, but -
to be honest, with my current workload, I'm struggling to catch up with
Plone 4 in the theme reference manual as a whole. So it might have more
of a chance outside of the core docs area.
Any thoughts?
Anne
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in
the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs
--
Alexander Limi · http://limi.net

[Alexander Limi]

Ah, I see. Well, I don't think there's any doubt that it's quickly becoming
best-practice (we have made lots of tweaks to 4.0 to make it work even
better), and it will be one of the cornerstones of Plone 5.

That being said, we probably need to make it a bit easier to get xdv up and
running, the primary issue right now is the sometimes-it-works-sometimes-not
binary egg for lxml on Windows/Mac.


On Wed, Feb 3, 2010 at 11:42 AM, Anne Bowtell

I'm definitely for the theming manual being separate from the developer's
manual. More a question of whether collective.xdv - as an aspect of theming,
should be part of our core set of reference manuals or should live outside
of the core since for the moment it is an optional add-on (as for instance
PloneFormGen documentation does).
Anne
In my (admittedly biased ;) opinion, theming is one of the things that
should possibly live outside of the "developer manual".
The goal of xdv and why we want to transition to it is that people should
need to have very minimal (ideally none at all!) knowledge of Plone, but
still be able to put a new look on a Plone site.
Having it as chapter N in a developer manual instead of a standalone manual
will make it less visible. Since they have two different core audiences, I'd
say that it's one of the manuals that it would make sense to put it on the
top level.
Of course, this is my opinion, doc team makes final call, etc, etc. :)
— Alexander

Post by Anne Bowtell
Apologies for cross-posting, I asked this question originally on the
Deliverance discussion list but it probably as much belongs here. I'm
interested to know opinions on where collective.xdv theming documentation
should live - given that it now has an entry in the add-on products section
of plone.org.
In the docs section of plone.org, we've got Alex Limi's manual - which,
although about rules-based theming in general is really an introduction
to collective.xdv. We've also got Deny's more advanced XDV tutorial
which is currently in the knowledge-base.
My question is really about Limi's manual. In the docs re-organization
this got absorbed into the core, into the theme reference manual - but
possibly this wasn't the right thing to do - it isn't really core yet
(PloneFormGen for instance which would be a comparable 'must have' is
documented in its product area).
Should we move Alex Limi's manual to the documentation area of the
collective.xdv product? (we would need some kind of redirect to be sure
that the link in Veda's book didn't break). In my view the theme
reference manual should simply have, at the moment, a review of the
principles of rule-based theming and directions to where the
documentation on collective.xdv, xdv and Deliverance can be found.
I'm very happy to help to keep it up-to-date where-ever it lives, but -
to be honest, with my current workload, I'm struggling to catch up with
Plone 4 in the theme reference manual as a whole. So it might have more
of a chance outside of the core docs area.
Any thoughts?
Anne
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the
business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

--
Alexander Limi · http://limi.net

[Alex Clark]

--===============7438199827982192040==
Content-Type: multipart/alternative; boundary=000e0cdf169c9df74c047eb812e2
--000e0cdf169c9df74c047eb812e2
Content-Type: text/plain; charset=windows-1252
Content-Transfer-Encoding: quoted-printable
Ah, I see. Well, I don't think there's any doubt that it's quickly becoming
best-practice (we have made lots of tweaks to 4.0 to make it work even
better), and it will be one of the cornerstones of Plone 5.
That being said, we probably need to make it a bit easier to get xdv up and
running, the primary issue right now is the sometimes-it-works-sometimes-no=
t
binary egg for lxml on Windows/Mac.

It is still a bit wonky to install. On a recent Debian 5 installation(s), I've done
"aptitude install libxslt-dev" or something like that to get it going. It seems
to me staticlxml was supposed to handle this by allowing you to forcefully build
the deps (libxslt/libxml2) inside your buildout, but that seemed to not work for me
recently.

Anyway, it seems like you can get this going in Windows now, according to their
docs¹:

On MS Windows, the above will install the binary builds that we provide. If there is no binary build of the latest release yet, please search PyPI for the last release that has them and pass that version to easy_install like this:

easy_install lxml==2.2.2

¹http://codespeak.net/lxml/installation.html

On Wed, Feb 3, 2010 at 11:42 AM, Anne Bowtell

I'm definitely for the theming manual being separate from the developer'=

s

manual. More a question of whether collective.xdv - as an aspect of themi=

ng,

should be part of our core set of reference manuals or should live outsid=

e

of the core since for the moment it is an optional add-on (as for instanc=

e

PloneFormGen documentation does).
Anne
In my (admittedly biased ;) opinion, theming is one of the things that
should possibly live outside of the "developer manual".
The goal of xdv and why we want to transition to it is that people should
need to have very minimal (ideally none at all!) knowledge of Plone, but
still be able to put a new look on a Plone site.
Having it as chapter N in a developer manual instead of a standalone manu=

al

will make it less visible. Since they have two different core audiences, =

I'd

say that it's one of the manuals that it would make sense to put it on th=

e

top level.
Of course, this is my opinion, doc team makes final call, etc, etc. :)
=97 Alexander

Post by Anne Bowtell
Apologies for cross-posting, I asked this question originally on the
Deliverance discussion list but it probably as much belongs here. I'm
interested to know opinions on where collective.xdv theming documentatio=

n

Post by Anne Bowtell
should live - given that it now has an entry in the add-on products sect=

ion

Post by Anne Bowtell
of plone.org.
In the docs section of plone.org, we've got Alex Limi's manual - which,
although about rules-based theming in general is really an introduction
to collective.xdv. We've also got Deny's more advanced XDV tutorial
which is currently in the knowledge-base.
My question is really about Limi's manual. In the docs re-organization
this got absorbed into the core, into the theme reference manual - but
possibly this wasn't the right thing to do - it isn't really core yet
(PloneFormGen for instance which would be a comparable 'must have' is
documented in its product area).
Should we move Alex Limi's manual to the documentation area of the
collective.xdv product? (we would need some kind of redirect to be sure
that the link in Veda's book didn't break). In my view the theme
reference manual should simply have, at the moment, a review of the
principles of rule-based theming and directions to where the
documentation on collective.xdv, xdv and Deliverance can be found.
I'm very happy to help to keep it up-to-date where-ever it lives, but -
to be honest, with my current workload, I'm struggling to catch up with
Plone 4 in the theme reference manual as a whole. So it might have more
of a chance outside of the core docs area.
Any thoughts?
Anne
------------------------------------------------------------------------=

------

Post by Anne Bowtell
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the
business
Choose flexible plans and management services without long-term contract=

s

Post by Anne Bowtell
Personal 24x7 support from experience hosting pros just a phone call awa=

y.

Post by Anne Bowtell
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

--
Alexander Limi =B7 http://limi.net

--=20
Alexander Limi =B7 http://limi.net
--000e0cdf169c9df74c047eb812e2
Content-Type: text/html; charset=windows-1252
Content-Transfer-Encoding: quoted-printable
Ah, I see. Well, I don&#39;t think there&#39;s any doubt that it&#39;s quic=
kly becoming best-practice (we have made lots of tweaks to 4.0 to make it w=
ork even better), and it will be one of the cornerstones of Plone 5.<br>
<br>That being said, we probably need to make it a bit easier to get xdv up=
and running, the primary issue right now is the sometimes-it-works-sometim=
es-not binary egg for lxml on Windows/Mac.<br><br><br><div class=3D"gmail_q=
uote">
On Wed, Feb 3, 2010 at 11:42 AM, Anne Bowtell <span dir=3D"ltr">&lt;<a href=
t;</span> wrote:<br><blockquote class=3D"gmail_quote" style=3D"margin: 0pt =
0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex=
;">
=20
=20
<div bgcolor=3D"#ffffff" text=3D"#000000">
I&#39;m definitely for the theming manual being separate from the
developer&#39;s manual. More a question of whether collective.xdv - as an
aspect of theming, should be part of our core set of reference manuals
or should live outside of the core since for the moment it is an
optional add-on (as for instance PloneFormGen documentation does).<br><font=
color=3D"#888888">
<br>
Anne</font><div><div></div><div class=3D"h5"><br>
<br>
<blockquote type=3D"cite">In my (admittedly biased ;) opinion, theming is o=
ne of the
things that should possibly live outside of the &quot;developer manual&quot=
;.<br>
<br>
The goal of xdv and why we want to transition to it is that people
should need to have very minimal (ideally none at all!) knowledge of
Plone, but still be able to put a new look on a Plone site.<br>
<br>
Having it as chapter N in a developer manual instead of a standalone
manual will make it less visible. Since they have two different core
audiences, I&#39;d say that it&#39;s one of the manuals that it would make
sense to put it on the top level.<br>
<br>
Of course, this is my opinion, doc team makes final call, etc, etc. :)<br>
<br>
=97 Alexander<br>
<br>
<div class=3D"gmail_quote">2010/2/3 Anne Bowtell <span dir=3D"ltr">&lt;<a=
<blockquote class=3D"gmail_quote" style=3D"border-left: 1px solid rgb(204=
, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">Apologies
for cross-posting, I asked this question originally on the Deliverance
discussion list but it probably as much belongs here. =A0I&#39;m interested
to know opinions on where collective.xdv theming documentation should
live - given that it now has an entry in the add-on products section of
<a href=3D"http://plone.org" target=3D"_blank">plone.org</a>.<br>
<br>
In the docs section of <a href=3D"http://plone.org" target=3D"_blank">plone=
.org</a>, we&#39;ve got Alex
Limi&#39;s manual - which,<br>
although about rules-based theming in general is really an introduction<br>
to collective.xdv. We&#39;ve also got Deny&#39;s more advanced XDV tutorial=
<br>
which is currently in the knowledge-base.<br>
<br>
My question is really about Limi&#39;s manual. In the docs re-organization<=
br>
this got absorbed into the core, into the theme reference manual - but<br>
possibly this wasn&#39;t the right thing to do - it isn&#39;t really core y=
et<br>
(PloneFormGen for instance which would be a comparable &#39;must have&#39; =
is<br>
documented in its product area).<br>
<br>
Should we move Alex Limi&#39;s manual to the documentation area of the<br>
collective.xdv product? (we would need some kind of redirect to be sure<br>
that the link in Veda&#39;s book didn&#39;t break). In my view the theme<br=
reference manual should simply have, at the moment, a review of the<br>
principles of rule-based theming and directions to where the<br>
documentation on collective.xdv, xdv and Deliverance can be found.<br>
<br>
I&#39;m very happy to help to keep it up-to-date where-ever it lives, but -=
<br>
to be honest, with my current workload, I&#39;m struggling to catch up with=
<br>
Plone 4 in the theme reference manual as a whole. So it might have more<br>
of a chance outside of the core docs area.<br>
<br>
Any thoughts?<br>
<font color=3D"#888888"><br>
Anne<br>
<br>
</font><br>
---------------------------------------------------------------------------=
---<br>
The Planet: dedicated and managed hosting, cloud storage, colocation<br>
Stay online with enterprise data centers and the best network in the
business<br>
Choose flexible plans and management services without long-term
contracts<br>
Personal 24x7 support from experience hosting pros just a phone call
away.<br>
<a href=3D"http://p.sf.net/sfu/theplanet-com" target=3D"_blank">http://=
p.sf.net/sfu/theplanet-com</a><br>
_______________________________________________<br>
Plone-docs mailing list<br>
<a href=3D"https://lists.sourceforge.net/lists/listinfo/plone-docs" tar=
get=3D"_blank">https://lists.sourceforge.net/lists/listinfo/plone-docs</a><=
br>
<br>
</blockquote>
</div>
<br>
<br clear=3D"all">
<br>
-- <br>
Alexander Limi =B7 <a href=3D"http://limi.net" target=3D"_blank">http://lim=
i.net</a><br>
</blockquote>
<br>
</div></div></div>
</blockquote></div><br><br clear=3D"all"><br>-- <br>Alexander Limi =B7 <a h=
ref=3D"http://limi.net">http://limi.net</a><br>
--000e0cdf169c9df74c047eb812e2--
--===============7438199827982192040==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
--===============7438199827982192040==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs
--===============7438199827982192040==--

[Shane Graber]

Post by Alexander Limi
That being said, we probably need to make it a bit easier to get xdv up

and

Post by Alexander Limi
running, the primary issue right now is the

sometimes-it-works-sometimes-no=

Post by Alexander Limi
t
binary egg for lxml on Windows/Mac.

It is still a bit wonky to install. On a recent Debian 5 installation(s), I've done
"aptitude install libxslt-dev" or something like that to get it going. It seems
to me staticlxml was supposed to handle this by allowing you to forcefully build
the deps (libxslt/libxml2) inside your buildout, but that seemed to not work for me
recently.

I had real problems getting lxml installed in the latest Ubuntu release
(9.1). libxml2-dev was not available via apt. I ended up finding a post on
Ubuntu's forums (no link atm) that it doesn't show up via command line/apt
but you could install it via the GUI software package installer. I fired up
the GUI installer and there it was. After installing it everything went
fine.

Shane

[Dylan Jay]

Post by Alexander Limi
In my (admittedly biased ;) opinion, theming is one of the things
that should possibly live outside of the "developer manual".

+1

on the same topic I think buildout related topics of install and
deployment should probably be a separate manual (and really doesn't
need to iive in svn either).

Post by Alexander Limi
The goal of xdv and why we want to transition to it is that people
should need to have very minimal (ideally none at all!) knowledge of
Plone, but still be able to put a new look on a Plone site.
Having it as chapter N in a developer manual instead of a standalone
manual will make it less visible. Since they have two different core
audiences, I'd say that it's one of the manuals that it would make
sense to put it on the top level.
Of course, this is my opinion, doc team makes final call, etc, etc. :)
— Alexander
Apologies for cross-posting, I asked this question originally on the
Deliverance discussion list but it probably as much belongs here.
I'm interested to know opinions on where collective.xdv theming
documentation should live - given that it now has an entry in the
add-on products section of plone.org.
In the docs section of plone.org, we've got Alex Limi's manual - which,
although about rules-based theming in general is really an
introduction
to collective.xdv. We've also got Deny's more advanced XDV tutorial
which is currently in the knowledge-base.
My question is really about Limi's manual. In the docs re-organization
this got absorbed into the core, into the theme reference manual - but
possibly this wasn't the right thing to do - it isn't really core yet
(PloneFormGen for instance which would be a comparable 'must have' is
documented in its product area).
Should we move Alex Limi's manual to the documentation area of the
collective.xdv product? (we would need some kind of redirect to be sure
that the link in Veda's book didn't break). In my view the theme
reference manual should simply have, at the moment, a review of the
principles of rule-based theming and directions to where the
documentation on collective.xdv, xdv and Deliverance can be found.
I'm very happy to help to keep it up-to-date where-ever it lives, but -
to be honest, with my current workload, I'm struggling to catch up with
Plone 4 in the theme reference manual as a whole. So it might have more
of a chance outside of the core docs area.
Any thoughts?
Anne
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the
business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs
--
Alexander Limi · http://limi.net
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the
business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Martin Aspeli]

Post by Anne Bowtell
Apologies for cross-posting, I asked this question originally on the
Deliverance discussion list but it probably as much belongs here. I'm
interested to know opinions on where collective.xdv theming
documentation should live - given that it now has an entry in the add-on
products section of plone.org.

An update on this:

In the past two days, Laurence and I have added some pretty
comprehensive documentation to XDV (which you can see on PyPI at
http://pypi.python.org/pypi/xdv, though it's updated even more in svn)
and collective.xdv (unreleased for now, but see
http://svn.plone.org/svn/collective/collective.xdv/trunk/README.txt).

In particular, there's a "worked example" for creating an XDV theme
package that is redistributable and works with static content.

XDV has grown in the past few weeks and months, as has collective.xdv. I
think this would be a great opportunity to revisit and consolidate the
various XDV docs on plone.org, so that they are (a) relevant and (b)
promote best practice.

I think in part these can refer to the above resources for reference
info, but the more step-by-step approach of the tutorials, and coverage
of important things like XPath and Firebug still have a place in more
user-focused tutorials on plone.org.

If nothing else, consider that new people are likely to come to
plone.org asking "how to I theme Plone". They are *not* likely to search
PyPI for "XDV". ;-)

Martin

[Alexander Limi]

This is great! Although the introduction isn't really that useful, it
references another product that people probably don't know about
(Deliverance).

A human-readable first paragraph will go a long way. I tried to come up with
a good one, but failed. :P

On Thu, Mar 25, 2010 at 9:01 AM, Martin Aspeli

Post by Martin Aspeli

Post by Anne Bowtell
Apologies for cross-posting, I asked this question originally on the
Deliverance discussion list but it probably as much belongs here. I'm
interested to know opinions on where collective.xdv theming
documentation should live - given that it now has an entry in the add-on
products section of plone.org.

In the past two days, Laurence and I have added some pretty
comprehensive documentation to XDV (which you can see on PyPI at
http://pypi.python.org/pypi/xdv, though it's updated even more in svn)
and collective.xdv (unreleased for now, but see
http://svn.plone.org/svn/collective/collective.xdv/trunk/README.txt).
In particular, there's a "worked example" for creating an XDV theme
package that is redistributable and works with static content.
XDV has grown in the past few weeks and months, as has collective.xdv. I
think this would be a great opportunity to revisit and consolidate the
various XDV docs on plone.org, so that they are (a) relevant and (b)
promote best practice.
I think in part these can refer to the above resources for reference
info, but the more step-by-step approach of the tutorials, and coverage
of important things like XPath and Firebug still have a place in more
user-focused tutorials on plone.org.
If nothing else, consider that new people are likely to come to
plone.org asking "how to I theme Plone". They are *not* likely to search
PyPI for "XDV". ;-)
Martin
--
Author of `Professional Plone Development`, a book for developers who
want to work with Plone. See http://martinaspeli.net/plone-book
------------------------------------------------------------------------------
Download Intel&#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Martin Aspeli]

Post by Alexander Limi
This is great! Although the introduction isn't really that useful, it
references another product that people probably don't know about
(Deliverance).
A human-readable first paragraph will go a long way. I tried to come up
with a good one, but failed. :P

You mean the XDV or the collective.xdv first paragraph?

Martin

[Alexander Limi]

On Thu, Mar 25, 2010 at 5:22 PM, Martin Aspeli

Post by Martin Aspeli

Post by Alexander Limi
This is great! Although the introduction isn't really that useful, it
references another product that people probably don't know about
(Deliverance).
A human-readable first paragraph will go a long way. I tried to come up
with a good one, but failed. :P

You mean the XDV or the collective.xdv first paragraph?

The one you linked to: http://pypi.python.org/pypi/xdv — but collective.xdv
could definitely use an overhaul too:
http://pypi.python.org/pypi/collective.xdv

"What does it let you do?"

[Martin Aspeli]

Post by Alexander Limi
On Thu, Mar 25, 2010 at 5:22 PM, Martin Aspeli

Post by Alexander Limi
This is great! Although the introduction isn't really that useful, it
references another product that people probably don't know about
(Deliverance).
A human-readable first paragraph will go a long way. I tried to

come up

Post by Alexander Limi
with a good one, but failed. :P

You mean the XDV or the collective.xdv first paragraph?
The one you linked to: http://pypi.python.org/pypi/xdv — but
http://pypi.python.org/pypi/collective.xdv
"What does it let you do?"

Any better?

http://codespeak.net/svn/z3/xdv/trunk/README.txt
http://svn.plone.org/svn/collective/collective.xdv/trunk/README.txt

I know it still references Deliverance, but it also tells you exactly
what it's for.

Martin

[Alexander Limi]

On Fri, Mar 26, 2010 at 8:52 PM, Martin Aspeli

Post by Martin Aspeli
Any better?
http://codespeak.net/svn/z3/xdv/trunk/README.txt
http://svn.plone.org/svn/collective/collective.xdv/trunk/README.txt

Much better!

Post by Martin Aspeli
I know it still references Deliverance, but it also tells you exactly
what it's for.

Yeah, referencing Deliverance is OK, as long as it explains what it does
too. It didn't earlier. :)