plone-docs — Discussion about the Plone documentation

Re: [Plone-docs] documentation for plone.app.blob on plone.org needs update

[Israel S. P. <duk...@gm...>]

Hi Kees,

Thanks a lot for reporting this issue. I've updated the Archetypes Developer
Manual fields reference accordingly. Could you check it out and see if
everything's ok now?

-- israel



2010/12/8 Kees Hink <hi...@gw...>

> I see now that the poster in the mailing list complains about a page in the
> archetypes developer manual [1], not about the one in the plone 4
> blobstorage
> page [2]. I can't edit the archetypes page.
>
> The archetypes page's BlobField information is still sparse, and it doesn't
> mention import ImageField from plone.app.blob.field. It's also a bit
> redundant.
> For the sake of keeping documentation in one place, would it be a good idea
> to
> link to [2]?
>
> [1]
>
> http://plone.org/documentation/manual/developer-manual/archetypes/fields/fields-reference#blob_field
>
> [2]
>
> http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0/updating-add-on-products-for-plone-4.0/use-plone.app.blob-based-blob-storage
>
> On 12/08/2010 10:08 AM, Kees Hink wrote:
> > I just found out that i actually can change the page, so i did.
> >
> > On 12/08/2010 10:05 AM, Kees Hink wrote:
> >> I followed the instructions on plone.org about adding blobfields to
> content
> >> type [1], but the first example (for ImageField) doesn't work
> (AttributeError
> >> for getAvailableSizes). I found the answer in a mailing list [2]. Like
> someone
> >> on the list suggested: i think the doc should be updated. I'd do it
> myself if i
> >> could.
> >>
> >> Kees
> >>
> >> [1]
> >>
> http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0/updating-add-on-products-for-plone-4.0/use-plone.app.blob-based-blob-storage
> ,
> >>
> >> [2]
> >>
> http://plone.293351.n2.nabble.com/Plone-4b3-ImageWidget-and-AttributeError-getAvailableSizes-td5076850.html
> >
> >
> ------------------------------------------------------------------------------
> > What happens now with your Lotus Notes apps - do you make another costly
> > upgrade, or settle for being marooned without product support? Time to
> move
> > off Lotus Notes and onto the cloud with Force.com, apps are easier to
> build,
> > use, and manage than apps on traditional platforms. Sign up for the Lotus
> > Notes Migration Kit to learn more. http://p.sf.net/sfu/salesforce-d2d
>
>
>
> ------------------------------------------------------------------------------
> What happens now with your Lotus Notes apps - do you make another costly
> upgrade, or settle for being marooned without product support? Time to move
> off Lotus Notes and onto the cloud with Force.com, apps are easier to
> build,
> use, and manage than apps on traditional platforms. Sign up for the Lotus
> Notes Migration Kit to learn more. http://p.sf.net/sfu/salesforce-d2d
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs
>

Re: [Plone-docs] documentation for plone.app.blob on plone.org needs update

[Kees H. <hi...@gw...>]

I see now that the poster in the mailing list complains about a page in the
archetypes developer manual [1], not about the one in the plone 4 blobstorage
page [2]. I can't edit the archetypes page.

The archetypes page's BlobField information is still sparse, and it doesn't
mention import ImageField from plone.app.blob.field. It's also a bit redundant.
For the sake of keeping documentation in one place, would it be a good idea to
link to [2]?

[1]
http://plone.org/documentation/manual/developer-manual/archetypes/fields/fields-reference#blob_field

[2]
http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0/updating-add-on-products-for-plone-4.0/use-plone.app.blob-based-blob-storage

On 12/08/2010 10:08 AM, Kees Hink wrote:
> I just found out that i actually can change the page, so i did.
> 
> On 12/08/2010 10:05 AM, Kees Hink wrote:
>> I followed the instructions on plone.org about adding blobfields to content
>> type [1], but the first example (for ImageField) doesn't work (AttributeError
>> for getAvailableSizes). I found the answer in a mailing list [2]. Like someone
>> on the list suggested: i think the doc should be updated. I'd do it myself if i
>> could.
>>
>> Kees
>>
>> [1]
>> http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0/updating-add-on-products-for-plone-4.0/use-plone.app.blob-based-blob-storage,
>>
>> [2]
>> http://plone.293351.n2.nabble.com/Plone-4b3-ImageWidget-and-AttributeError-getAvailableSizes-td5076850.html
> 
> ------------------------------------------------------------------------------
> What happens now with your Lotus Notes apps - do you make another costly 
> upgrade, or settle for being marooned without product support? Time to move
> off Lotus Notes and onto the cloud with Force.com, apps are easier to build,
> use, and manage than apps on traditional platforms. Sign up for the Lotus 
> Notes Migration Kit to learn more. http://p.sf.net/sfu/salesforce-d2d

Re: [Plone-docs] documentation for plone.app.blob on plone.org needs update

[Kees H. <hi...@gw...>]

I just found out that i actually can change the page, so i did.

On 12/08/2010 10:05 AM, Kees Hink wrote:
> I followed the instructions on plone.org about adding blobfields to content
> type [1], but the first example (for ImageField) doesn't work (AttributeError
> for getAvailableSizes). I found the answer in a mailing list [2]. Like someone
> on the list suggested: i think the doc should be updated. I'd do it myself if i
> could.
> 
> Kees
> 
> [1]
> http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0/updating-add-on-products-for-plone-4.0/use-plone.app.blob-based-blob-storage,
> 
> [2]
> http://plone.293351.n2.nabble.com/Plone-4b3-ImageWidget-and-AttributeError-getAvailableSizes-td5076850.html

[Plone-docs] documentation for plone.app.blob on plone.org needs update

[Kees H. <hi...@gw...>]

I followed the instructions on plone.org about adding blobfields to content
type [1], but the first example (for ImageField) doesn't work (AttributeError
for getAvailableSizes). I found the answer in a mailing list [2]. Like someone
on the list suggested: i think the doc should be updated. I'd do it myself if i
could.

Kees

[1]
http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0/updating-add-on-products-for-plone-4.0/use-plone.app.blob-based-blob-storage,


[2]
http://plone.293351.n2.nabble.com/Plone-4b3-ImageWidget-and-AttributeError-getAvailableSizes-td5076850.html

[Plone-docs] PHC 4.0a1 is released

[Israel S. P. <duk...@gm...>]

Hi folks,

I've recently released PHC 4.0a1. This release works on Plone 4 and 
includes numerous bug fixes.

One of the most important ones was to refactor the workflow definitions 
to make the @@sharing page work as expected. This will hopefully allow 
the Collective Commiters group in plone.org to edit the articles in the 
KB freely (it was not working previously).

Thanks to everyone who contributed to this release, either with bug 
reports or patches. I'm looking forward for new releases already. :)

-- israel


Full changelog:

     PloneHelpCenter 4.0a1 (2010-12-07)

     - Use lxml to turn image relative links into absolute for the
       one-page version of manuals. This introduces a new install
       dependency on lxml.
       Fixes http://plone.org/products/plonehelpcenter/issues/136.
       [dukebody]

     - Include numbering in the section title.
       Fixes http://plone.org/products/plonehelpcenter/issues/137.
       [dukebody]

     - Rename type titles: "Page" to "Tutorial Page" and "Link" to
       "Help Center Link".
       Fixes http://plone.org/products/plonehelpcenter/issues/140.
       [dukebody]

     - Made it possible to query contentIds via XML-RPC for
       collective.developermanual uploads [miohtama]

     - Use the aq_parent function instead of the attribute to avoid
       AttributeErrors when not using an acquisition wrapper (newer
       Zope versions).
       [dukebody]

     - Fix next/previous custom adapter to visit the same items as appear in
       the navigation dropdown. Also make sure this adapter is used for 
legacy
       ReferenceManuals. This fixes
       http://plone.org/products/plonehelpcenter/issues/152/.
       [dukebody, davisagli]

     - Don't fail when trying to acquire getCurrentVersions if not in
       a container that includes currentVersions in its schema. [davisagli]

     - Fix the imports to use always Zope 3 style interfaces, making
       the code work both in Plone 3 and 4 simultaneuslly.
       [dukebody, thanks davisagli]

     - Merge relevant changes from the Plone 4 migration branch from
       Fabio Rizzo. [dukebody]

     - Reverted obsolete code from the referencemanual_view.pt fix. [acsr]

     - Updated INSTALL.txt with step by step upgrade guide related to 
issue #142 "upgrade steps order unclear" and issue #132 "errata 
mentioning Ploneboard". [acsr]

     - Fixed an issue with failure to display referencemanual_view when
       files are present in the reference manual. [acsr, thanks dukebody]

     - Update the whole product to work with Plone 4.0a2. [dukebody]

     - Removed "global allow" for Reference Manual. This closes
       http://plone.org/products/plonehelpcenter/issues/150.
       [keul]

     - updated INSTALL.txt with step by step upgrade guide related to
       issue #142 "upgrade steps order unclear" and issue #132 "errata
       mentioning Ploneboard". [acsr]

     - Respect exclude_from_nav setting in the reference manual
       table of contents generation [miohtama]

Re: [Plone-docs] Drafting the documentation page

[John S. <jo...@ec...>]

Aloha,

On 12/02/2010 08:12 AM, Israel Saeta Pérez wrote:
> On 02/12/10 00:40, John Schinnerer wrote:
>> Aloha,
>>
>>> Israel Saeta Pérez wrote:
>>>>
>>>> Hey,
>>>>
>>>> Nicolas Vasseur has been working on a cleaner plone.org/documentation
>>>> page. Please check:
>>>>
>>>> http://plone.org/documentation/helpcenter_ploneorg2
>>>>
>>>> and tell us what you think. We want something clean and simple, pointing
>>>> to our best manuals, as agreed before, and with links to other sections
>>>> like the KB, error reference, faqs...
>>>>
>>>> Any comments appreciated!
>>
>> So far so good overall, I would say. Seems pretty obvious where to go
>> for what, and there's not so much at once that it's overwhelming.
>>
>> The "by topic" sidebar is a good thing to have.
>> And I would suggest put newest stuff first, oldest stuff last in what is
>> displayed via those sidebar links.
>> For example when I click on 'visual design' under 'Customizing Plone' in
>> that sidebar, the second item displayed under "creating theme products"
>> is "Creating a new theme for Plone: a real-world example (Plone 2.1,
>> 2.5)". I suggest it ought to be down at the end of that section with the
>> link to the old DIYPloneStyle 2.x item.
>> In short, list Plone 4 and/or non-version-specific, and then 3.x, and
>> then 2.x.
>> Also, some indication as to what the gold stars next to an item mean.
>
>
> I think that these lists of content are collections generated
> programatically, so we don't have too much control of the sorting.
> Showing the starred items first, then by date is an option, though.
> Would you agree with that?

Yeah, I was assuming they are collections (which are great for 
collecting but could use more sorting abilities :-)...
Anything that would put them in order of newer plone stuff first would I 
think help, so by date ought to do it (2.5 stuff should have an older 
date than 3, and 3 older than 4, yes?)

> Also, some elements show up at the same page in several different
> categories, which is wrong. I think that we should remove most
> categories and leave just "Installing and upgrading" (would cover also
> moving and buildouts config), "Customization" (would cover every
> customization that doesn't need coding) "Theming" and "Development"
> (would include i18n/l10n). This is just a suggestion. I think that the
> less topics the better, since people nowadays don't browse documentation
> by topic, but use Google to search by terms, which is much smarter.

I generally agree with the above.

Also great work on addressing others' comments, it seems yet cleaner and 
clearer now, thanks!

cheers,
John S.



-- 
John Schinnerer - M.A., Whole Systems Design
--------------------------------------------
- Eco-Living -
Whole Systems Design Services
People - Place - Learning - Integration
jo...@ec...
http://eco-living.net

Re: [Plone-docs] Drafting the documentation page

[Israel S. P. <duk...@gm...>]

Hi Dylan,

2010/12/2 Dylan Jay <dy...@dy...>

> On 31/10/2010, at 4:04 AM, Israel Saeta Pérez wrote:
>
>  Hey,
>>
>> Nicolas Vasseur has been working on a cleaner plone.org/documentation
>> page. Please check:
>>
>> http://plone.org/documentation/helpcenter_ploneorg2
>>
>> and tell us what you think. We want something clean and simple, pointing
>> to our best manuals, as agreed before, and with links to other sections
>> like the KB, error reference, faqs...
>>
>> Any comments appreciated!
>>
>
> very much clearer.
>
> One thing that perhaps could be made more clearer is that the "find
> documentation by topic" on the side bar.
>
> For instance if I click on "Installation" I get
> http://plone.org/documentation/phc_topic_area?topic=Installation
> which has the "Installing Plone" manual 3rd down the list. It does'nt
> really show that the manual is our "best effort" quality documentation and
> the others are user submitted.
>
>
I've starred it so it shows up now the first of its category. :)


> I'm not well versed on the cababilities of PHC but just off the top of my
> head are the following possible?
>
> - For each Topic on the side bar have "Manual" as first subtopic and have
> the manual underneath it?
>
> or
>
> - For each subtopic under a topic, e.g. Linux under Installation, have the
> first link be a to the appropriate chapter of the manual?
>
> other ideas?
>
>

Yes, the documentation by topic feature is broken right now. The
Installation, User, Theming, Development, and Community Development manuals
are already there. If we star them ("Start Here") they will show up first
for the appropiate topic. As I mentioned in another mail, I think we should
reduce the lists of topics to make it minimally useful.


> or are we just better off spending more time merging the kb items into
> manuals or removing them?
>
>
I don't think we could ever get this done. They're too many, and we want
everybody to manage the documents in the kb organically, not have us to do
all the merging work.

-- israel

Re: [Plone-docs] Drafting the documentation page

[Israel S. P. <duk...@gm...>]

Hi,

2010/10/30 David Glick <dav...@gr...>

> On 10/30/10 6:04 PM, Israel Saeta Pérez wrote:
> > Hey,
> >
> > Nicolas Vasseur has been working on a cleaner plone.org/documentation
> > page. Please check:
> >
> > http://plone.org/documentation/helpcenter_ploneorg2
> >
> > and tell us what you think. We want something clean and simple, pointing
> > to our best manuals, as agreed before, and with links to other sections
> > like the KB, error reference, faqs...
> >
> > Any comments appreciated!
> I think this is a big improvement over the old page.
>
> A few comments:
>  - It may be good for the knowledgebase landing page to have a portlet
> explaining that it is an area open to contribution.
>

Done :)

http://plone.org/documentation/kb


However, due to a problem with the permissions, the "Editor" role doesn't
have the "Edit portal content" permission in the documentation (insane
workflow perms settings?), using "Can Edit" with the CollectiveCommiters
group in the sharing page of the Knowledge Base has no effect. I need to fix
this.


>  - Maybe add small links to the Plone 2.5 and Plone 3 user manuals below
> the Plone 4 user manual link?
>

Done!
http://plone.org/documentation/helpcenter_ploneorg2


>  - Maybe include a link to the trac page which has info on how to help
> develop Plone?
>

Done!
Check the "Contribute" portlet to the right of the docs front page.

Thanks very much for your feedback!

-- israel

Re: [Plone-docs] Drafting the documentation page

[Israel S. P. <duk...@gm...>]

On 02/12/10 00:40, John Schinnerer wrote:
> Aloha,
>
>> Israel Saeta Pérez wrote:
>>>
>>> Hey,
>>>
>>> Nicolas Vasseur has been working on a cleaner plone.org/documentation
>>> page. Please check:
>>>
>>> http://plone.org/documentation/helpcenter_ploneorg2
>>>
>>> and tell us what you think. We want something clean and simple, pointing
>>> to our best manuals, as agreed before, and with links to other sections
>>> like the KB, error reference, faqs...
>>>
>>> Any comments appreciated!
>
> So far so good overall, I would say. Seems pretty obvious where to go
> for what, and there's not so much at once that it's overwhelming.
>
> The "by topic" sidebar is a good thing to have.
> And I would suggest put newest stuff first, oldest stuff last in what is
> displayed via those sidebar links.
> For example when I click on 'visual design' under 'Customizing Plone' in
> that sidebar, the second item displayed under "creating theme products"
> is "Creating a new theme for Plone: a real-world example (Plone 2.1,
> 2.5)". I suggest it ought to be down at the end of that section with the
> link to the old DIYPloneStyle 2.x item.
> In short, list Plone 4 and/or non-version-specific, and then 3.x, and
> then 2.x.
> Also, some indication as to what the gold stars next to an item mean.


I think that these lists of content are collections generated 
programatically, so we don't have too much control of the sorting. 
Showing the starred items first, then by date is an option, though. 
Would you agree with that?

Also, some elements show up at the same page in several different 
categories, which is wrong. I think that we should remove most 
categories and leave just "Installing and upgrading" (would cover also 
moving and buildouts config), "Customization" (would cover every 
customization that doesn't need coding) "Theming" and "Development" 
(would include i18n/l10n). This is just a suggestion. I think that the 
less topics the better, since people nowadays don't browse documentation 
by topic, but use Google to search by terms, which is much smarter.

Keywords (or Subjects) are also useless right now. I don't know if they 
show up or are used anywhere in any page in the documentation. :/  But 
they do not harm, so let's forget about them for now.


> For the main Documentation page a few more words of explanation under
> the link to "Theme reference" in the getting started section might be
> helpful to those new to Plone and its' terminology. Something drawn from
> this perhaps:
> "A theme is a collection of page templates, style sheets, components,
> and configuration settings that go to make up the individual look and
> feel of a Plone site" (the first sentence of "What's a Plone Theme?" page).


I've given the starting page another whirl, adding more descriptive 
descriptions and some introductory text ("Contribute" portlet). :)

Check it out at:
http://plone.org/documentation/helpcenter_ploneorg2

-- israel

Re: [Plone-docs] Drafting the documentation page

[John S. <jo...@ec...>]

Aloha,

> Israel Saeta Pérez wrote:
>>
>> Hey,
>>
>> Nicolas Vasseur has been working on a cleaner plone.org/documentation
>> page. Please check:
>>
>> http://plone.org/documentation/helpcenter_ploneorg2
>>
>> and tell us what you think. We want something clean and simple, pointing
>> to our best manuals, as agreed before, and with links to other sections
>> like the KB, error reference, faqs...
>>
>> Any comments appreciated!

So far so good overall, I would say. Seems pretty obvious where to go 
for what, and there's not so much at once that it's overwhelming.

The "by topic" sidebar is a good thing to have.
And I would suggest put newest stuff first, oldest stuff last in what is 
displayed via those sidebar links.
For example when I click on 'visual design' under 'Customizing Plone' in 
that sidebar, the second item displayed under "creating theme products" 
is "Creating a new theme for Plone: a real-world example (Plone 2.1, 
2.5)". I suggest it ought to be down at the end of that section with the 
link to the old DIYPloneStyle 2.x item.
In short, list Plone 4 and/or non-version-specific, and then 3.x, and 
then 2.x.
Also, some indication as to what the gold stars next to an item mean.

For the main Documentation page a few more words of explanation under 
the link to "Theme reference" in the getting started section might be 
helpful to those new to Plone and its' terminology. Something drawn from 
this perhaps:
"A theme is a collection of page templates, style sheets, components, 
and configuration settings that go to make up the individual look and 
feel of a Plone site" (the first sentence of "What's a Plone Theme?" page).

Thanks for all the great work!
cheers,
John S.

-- 
John Schinnerer - M.A., Whole Systems Design
--------------------------------------------
- Eco-Living -
Whole Systems Design Services
People - Place - Learning - Integration
jo...@ec...
http://eco-living.net

Re: [Plone-docs] Drafting the documentation page

[Dylan J. <dy...@dy...>]

On 31/10/2010, at 4:04 AM, Israel Saeta Pérez wrote:

> Hey,
>
> Nicolas Vasseur has been working on a cleaner plone.org/documentation
> page. Please check:
>
> http://plone.org/documentation/helpcenter_ploneorg2
>
> and tell us what you think. We want something clean and simple,  
> pointing
> to our best manuals, as agreed before, and with links to other  
> sections
> like the KB, error reference, faqs...
>
> Any comments appreciated!

very much clearer.

One thing that perhaps could be made more clearer is that the "find  
documentation by topic" on the side bar.

For instance if I click on "Installation" I get http://plone.org/documentation/phc_topic_area?topic=Installation
which has the "Installing Plone" manual 3rd down the list. It does'nt  
really show that the manual is our "best effort" quality documentation  
and the others are user submitted.

I'm not well versed on the cababilities of PHC but just off the top of  
my head are the following possible?

- For each Topic on the side bar have "Manual" as first subtopic and  
have the manual underneath it?

or

- For each subtopic under a topic, e.g. Linux under Installation, have  
the first link be a to the appropriate chapter of the manual?

other ideas?

or are we just better off spending more time merging the kb items into  
manuals or removing them?




>
> -- israel
>
>
> ------------------------------------------------------------------------------
> Nokia and AT&T present the 2010 Calling All Innovators-North America  
> contest
> Create new apps & games for the Nokia N8 for consumers in  U.S. and  
> Canada
> $10 million total in prizes - $4M cash, 500 devices, nearly $6M in  
> marketing
> Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi  
> Store
> http://p.sf.net/sfu/nokia-dev2dev
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs

Re: [Plone-docs] Drafting the documentation page

[rogererens <ro...@er...>]

Israel Saeta Pérez wrote:
> 
> Hey,
> 
> Nicolas Vasseur has been working on a cleaner plone.org/documentation 
> page. Please check:
> 
> http://plone.org/documentation/helpcenter_ploneorg2
> 
> and tell us what you think. We want something clean and simple, pointing 
> to our best manuals, as agreed before, and with links to other sections 
> like the KB, error reference, faqs...
> 
> Any comments appreciated!
> 
> 

I like it, since, especially for newcomers, it does not look overwhelming.
They will not think right away that learning Plone is a daunting task :-)
They'll find out later, hopefully after they've fallen in the 'Plone-trap',
ehm, fallen in love with Plone...
-- 
View this message in context: http://plone.293351.n2.nabble.com/Drafting-the-documentation-page-tp5689813p5793930.html
Sent from the Documentation Team mailing list archive at Nabble.com.

[Plone-docs] Typo in doc wrt updating a custom Plone3 buildout for Plone4

[rogererens <ro...@er...>]

In 
http://plone.org/documentation/manual/upgrade-guide/version/upgrading-plone-3-x-to-4.0/buildout-3-4
the upgrade document  step one mentions
'~/.buildout.default.cfg' which should be '~/.buildout/default.cfg'
-- 
View this message in context: http://plone.293351.n2.nabble.com/Typo-in-doc-wrt-updating-a-custom-Plone3-buildout-for-Plone4-tp5793963p5793963.html
Sent from the Documentation Team mailing list archive at Nabble.com.

Re: [Plone-docs] Plone Installation Guide

[Israel S. P. <duk...@gm...>]

On 28/11/10 21:28, iHack wrote:
>
> I am participating in Google's Code-In and I was supposed to create an
> Installation Manual.  My mentor preferred that I add it to the Plone
> Documentation and told me to visit the IRC channel for information on how to
> gain access to the Plone.org Documentation.  Hopefully I'm in the right
> place.
>
> The installation manual can be found
> http://www.google-melange.com/document/show/user/ihack/plone_installation
> here .

Hi Caleb,

thanks for tackling this and sorry for my late reply.

I've already reviewed your submission at the Google Code-In pages, with 
some comments.

Regarding the upload to plone.org, I could grant you access if you wish, 
but I think it will be easier and more hassle-free for you if I do it 
myself after your submission being approved.

Keep up good work,
-- israel

Re: [Plone-docs] Documentation encoding problem ?

[Dylan J. <dy...@dy...>]

On 09/11/2010, at 2:24 AM, Mikko Ohtamaa wrote:

>
> Hi,
>
>>
>> I took a quick look at the html output and it looks like those  
>> characters
>> are being created by the "html_use_smartypants" option. A temporary  
>> fix
>> would be to turn that option off in "source/conf.py".
>
> Panty option fixed ' character in the text. But links are still  
> broken.
>
> One possible culprint could be here:
>
> https://github.com/miohtama/transmogrify.siteanalyser/blob/master/transmogrify/siteanalyser/linkmanipulator.py 
> #L88
>
> fixLink() functoin explicitly sets href attribute for   node. Maybe  
> new lxml
> versions somehow automatically escape what's being inserted into href,
> breaking our links. However, this does not sound right... you  
> probably want
> to use : and # charcaters in links, unescaped.

I've checked in some fixes for this and also fixed the removing of  
the .html from links.

However the sources in the buildout has changed. you may need to purge  
and recheck out.

I'm also partly way through integrating the newly released http://pypi.python.org/pypi/funnelweb 
  so we have a nicer commandline.



>
> -Mikko
>
>>
>> Clayton
>> --
>> Six Feet Up, Inc. | Sponsor of Plone Conference 2010 (Oct. 25th-31st)
>> Direct Line: +1 (317) 861-5948 x603
>> Email: cl...@si...
>> Try Plone 4 Today at: http://plone4demo.com
>>
>> How am I doing? Please contact my manager Gabrielle Hendryx-Parker
>> at gab...@si... with any feedback.
>>
>>
>>
>
>
>
> -- 
> Mikko Ohtamaa
> mFabrik - Freedom Delivered.
>
> Web site - http://mfabrik.com
> Mobile site - http://mfabrik.mobi
> Blog - http://blog.mfabrik.com
>
>
> -----
> Mikko Ohtamaa
> mFabrik - Freedom Delivered.
>
> Web site - http://mfabrik.com
> Mobile site - http://mfabrik.mobi
> Blog - http://blog.mfabrik.com
> -- 
> View this message in context: http://plone.293351.n2.nabble.com/Documentation-encoding-problem-tp5716300p5717257.html
> Sent from the Documentation Team mailing list archive at Nabble.com.
>
> ------------------------------------------------------------------------------
> The Next 800 Companies to Lead America's Growth: New Video Whitepaper
> David G. Thomson, author of the best-selling book "Blueprint to a
> Billion" shares his insights and actions to help propel your
> business during the next growth cycle. Listen Now!
> http://p.sf.net/sfu/SAP-dev2dev
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs

Re: [Plone-docs] Documentation encoding problem ?

[Dylan J. <dy...@dy...>]

On 09/11/2010, at 2:24 AM, Mikko Ohtamaa wrote:

>
> Hi,
>
>>
>> I took a quick look at the html output and it looks like those  
>> characters
>> are being created by the "html_use_smartypants" option. A temporary  
>> fix
>> would be to turn that option off in "source/conf.py".
>
> Panty option fixed ' character in the text. But links are still  
> broken.
>
> One possible culprint could be here:
>
> https://github.com/miohtama/transmogrify.siteanalyser/blob/master/transmogrify/siteanalyser/linkmanipulator.py 
> #L88
>
> fixLink() functoin explicitly sets href attribute for   node. Maybe  
> new lxml
> versions somehow automatically escape what's being inserted into href,
> breaking our links. However, this does not sound right... you  
> probably want
> to use : and # charcaters in links, unescaped.

Hi,

I'm debugging a new version of transmogrify.siteanalyser that will fix  
this.


>
> -Mikko
>
>>
>> Clayton
>> --
>> Six Feet Up, Inc. | Sponsor of Plone Conference 2010 (Oct. 25th-31st)
>> Direct Line: +1 (317) 861-5948 x603
>> Email: cl...@si...
>> Try Plone 4 Today at: http://plone4demo.com
>>
>> How am I doing? Please contact my manager Gabrielle Hendryx-Parker
>> at gab...@si... with any feedback.
>>
>>
>>
>
>
>
> -- 
> Mikko Ohtamaa
> mFabrik - Freedom Delivered.
>
> Web site - http://mfabrik.com
> Mobile site - http://mfabrik.mobi
> Blog - http://blog.mfabrik.com
>
>
> -----
> Mikko Ohtamaa
> mFabrik - Freedom Delivered.
>
> Web site - http://mfabrik.com
> Mobile site - http://mfabrik.mobi
> Blog - http://blog.mfabrik.com
> -- 
> View this message in context: http://plone.293351.n2.nabble.com/Documentation-encoding-problem-tp5716300p5717257.html
> Sent from the Documentation Team mailing list archive at Nabble.com.
>
> ------------------------------------------------------------------------------
> The Next 800 Companies to Lead America's Growth: New Video Whitepaper
> David G. Thomson, author of the best-selling book "Blueprint to a
> Billion" shares his insights and actions to help propel your
> business during the next growth cycle. Listen Now!
> http://p.sf.net/sfu/SAP-dev2dev
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs

Re: [Plone-docs] Documentation encoding problem ?

[Mikko O. <mik...@re...>]

Hi,

>
> I took a quick look at the html output and it looks like those characters
> are being created by the "html_use_smartypants" option. A temporary fix
> would be to turn that option off in "source/conf.py".

Panty option fixed ' character in the text. But links are still broken.

One possible culprint could be here:

https://github.com/miohtama/transmogrify.siteanalyser/blob/master/transmogrify/siteanalyser/linkmanipulator.py#L88

fixLink() functoin explicitly sets href attribute for   node. Maybe new lxml
versions somehow automatically escape what's being inserted into href,
breaking our links. However, this does not sound right... you probably want
to use : and # charcaters in links, unescaped.

-Mikko

>
> Clayton
> --
> Six Feet Up, Inc. | Sponsor of Plone Conference 2010 (Oct. 25th-31st)
> Direct Line: +1 (317) 861-5948 x603
> Email: cl...@si...
> Try Plone 4 Today at: http://plone4demo.com
>
> How am I doing? Please contact my manager Gabrielle Hendryx-Parker
> at gab...@si... with any feedback.
>
>
>



-- 
Mikko Ohtamaa
mFabrik - Freedom Delivered.

Web site - http://mfabrik.com
Mobile site - http://mfabrik.mobi
Blog - http://blog.mfabrik.com


-----
Mikko Ohtamaa
mFabrik - Freedom Delivered.

Web site - http://mfabrik.com
Mobile site - http://mfabrik.mobi
Blog - http://blog.mfabrik.com
-- 
View this message in context: http://plone.293351.n2.nabble.com/Documentation-encoding-problem-tp5716300p5717257.html
Sent from the Documentation Team mailing list archive at Nabble.com.

Re: [Plone-docs] Documentation encoding problem ?

[Dylan J. <dy...@dy...>]

On 09/11/2010, at 1:13 AM, Clayton Parker wrote:

> On Nov 8, 2010, at 8:06 AM, Mikko Ohtamaa wrote:
>> francoise wrote:
>>>
>>> I have a strange display on some pages of the documentation, e.g
>>>
>>> http://plone.org/documentation/manual/plone-community-developer-documentation/portlets/assignments
>>>
>>
>> Links and texts are known to be broken. Somehow the latest updates  
>> have
>> broken them, before or after Plone Conference 2010. We do not know  
>> what has
>> caused this issues and currently there is no schedule when it will  
>> be fixed.
>
> I noticed the characters showing after the push during the sprints  
> in the documents that I migrated over. The characters look fine in  
> the static version and are being shown in utf-8.
>
> Seems like it is an issue with the content types created or the  
> transmogrifier pipeline.

I'll have a look into it.

>
> Clayton
> -- 
> Six Feet Up, Inc. | Sponsor of Plone Conference 2010 (Oct. 25th-31st)
> Direct Line: +1 (317) 861-5948 x603
> Email: cl...@si...
> Try Plone 4 Today at: http://plone4demo.com
>
> How am I doing? Please contact my manager Gabrielle Hendryx-Parker
> at gab...@si... with any feedback.
>
>
>
>
> ------------------------------------------------------------------------------
> The Next 800 Companies to Lead America's Growth: New Video Whitepaper
> David G. Thomson, author of the best-selling book "Blueprint to a
> Billion" shares his insights and actions to help propel your
> business during the next growth cycle. Listen Now!
> http://p.sf.net/sfu/SAP-dev2dev
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs

Re: [Plone-docs] Documentation encoding problem ?

[Clayton P. <cl...@si...>]

On Nov 8, 2010, at 9:28 AM, Dylan Jay wrote:

> On 09/11/2010, at 1:13 AM, Clayton Parker wrote:
> 
>> 
>> 
>> <snip>
>> 
>> I noticed the characters showing after the push during the sprints in the documents that I migrated over. The characters look fine in the static version and are being shown in utf-8.
>> 
>> Seems like it is an issue with the content types created or the transmogrifier pipeline.
> 
> I'll have a look into it.

I took a quick look at the html output and it looks like those characters are being created by the "html_use_smartypants" option. A temporary fix would be to turn that option off in "source/conf.py".

Clayton
-- 
Six Feet Up, Inc. | Sponsor of Plone Conference 2010 (Oct. 25th-31st)
Direct Line: +1 (317) 861-5948 x603
Email: cl...@si...
Try Plone 4 Today at: http://plone4demo.com

How am I doing? Please contact my manager Gabrielle Hendryx-Parker
at gab...@si... with any feedback.

Re: [Plone-docs] Documentation encoding problem ?

[Clayton P. <cl...@si...>]

On Nov 8, 2010, at 8:06 AM, Mikko Ohtamaa wrote:
> francoise wrote:
>> 
>> I have a strange display on some pages of the documentation, e.g 
>> 
>> http://plone.org/documentation/manual/plone-community-developer-documentation/portlets/assignments
>> 
> 
> Links and texts are known to be broken. Somehow the latest updates have
> broken them, before or after Plone Conference 2010. We do not know what has
> caused this issues and currently there is no schedule when it will be fixed.

I noticed the characters showing after the push during the sprints in the documents that I migrated over. The characters look fine in the static version and are being shown in utf-8.

Seems like it is an issue with the content types created or the transmogrifier pipeline.

Clayton
-- 
Six Feet Up, Inc. | Sponsor of Plone Conference 2010 (Oct. 25th-31st)
Direct Line: +1 (317) 861-5948 x603
Email: cl...@si...
Try Plone 4 Today at: http://plone4demo.com

How am I doing? Please contact my manager Gabrielle Hendryx-Parker
at gab...@si... with any feedback.

Re: [Plone-docs] Documentation encoding problem ?

[Mikko O. <mik...@re...>]

francoise wrote:
> 
> Hi ploners,
> 
> I have a strange display on some pages of the documentation, e.g 
>  
> http://plone.org/documentation/manual/plone-community-developer-documentation/portlets/assignments
> 

Hi,

Links and texts are known to be broken. Somehow the latest updates have
broken them, before or after Plone Conference 2010. We do not know what has
caused this issues and currently there is no schedule when it will be fixed.

-Mikko


-----
Mikko Ohtamaa
mFabrik - Freedom Delivered.

Web site - http://mfabrik.com
Mobile site - http://mfabrik.mobi
Blog - http://blog.mfabrik.com
-- 
View this message in context: http://plone.293351.n2.nabble.com/Documentation-encoding-problem-tp5716300p5716770.html
Sent from the Documentation Team mailing list archive at Nabble.com.

[Plone-docs] Documentation encoding problem ?

[francoise <fc...@gm...>]

Hi ploners,

I have a strange display on some pages of the documentation, e.g 
 
http://plone.org/documentation/manual/plone-community-developer-documentation/portlets/assignments

My browser defaut display encoding is UTF-8.


Portlet Assignments are stored in what’s called an Assignment Mapping.
This is an ordered container with a dict-like interface. The keys are unique
string names, and the values are instances of the assignment class.


Regards
   Françoise
-- 
View this message in context: http://plone.293351.n2.nabble.com/Documentation-encoding-problem-tp5716300p5716300.html
Sent from the Documentation Team mailing list archive at Nabble.com.

Re: [Plone-docs] Integrating comments back to the docs

[Israel S. P. <duk...@gm...>]

Hi folks,

One of the problems with comments was that notifications were only sent 
to the authors, who usually ignored them because they wrote the doc long 
time ago and no longer care too much about it. As a result, comments 
lingered for months at the end of doc items before somebody stumble upon 
them.

Another problem was that many people were using them as a support forum. 
As Dylan says, it's preferable to have a knowledge base open and 
editable by all registered users (with collective rights) so they can 
fix any errors right away instead of commenting and waiting for the 
author reply.

For the non-openly-editable docs, outside the knowledge base, the plan 
was to ask the users to open a ticket in trac should they find any 
errors/inconsistencies. This way, the whole docs team is notified and 
can fix the problem faster than a single author.

-- israel


On 03/11/10 00:10, Dylan Jay wrote:
> On 03/11/2010, at 6:03 AM, Mikko Ohtamaa<mik...@re...>  wrote:
>
>> Hi all,
>>
>> Jörg was asking in the conference to get discussion back to the
>> developers docs, as for example php.net the discussion is very active
>> and the you can easily find ready made recipes for your problems. We
>
>
> Actually from memory there was a deliberate decision to take away
> comments because they were a big source of out of date information.
> They'd need active curation by someone who doesn't exist.
> The alternative was to create the knowledgebase which is open editing
> so people are encouraged to add and edit. The developer manual is also
> open to be edited via the collective. Shouldn't we encourage this over
> half thought out comments?
>
>> also discussed shortly with Timo should we use plone.app.discussion or
>> Disqus for this.
>>
>> Now someone has set us an example to go forward:
>>
>> http://www.zodb.org/zodbbook/
>>
>> --
>> Mikko Ohtamaa
>> mFabrik - Freedom Delivered.
>>
>> Web site - http://mfabrik.com
>> Mobile site - http://mfabrik.mobi
>> Blog - http://blog.mfabrik.com
>>
>> ------------------------------------------------------------------------------
>> Nokia and AT&T present the 2010 Calling All Innovators-North America contest
>> Create new apps&  games for the Nokia N8 for consumers in  U.S. and Canada
>> $10 million total in prizes - $4M cash, 500 devices, nearly $6M in marketing
>> Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi Store
>> http://p.sf.net/sfu/nokia-dev2dev
>> _______________________________________________
>> Plone-docs mailing list
>> Plo...@li...
>> https://lists.sourceforge.net/lists/listinfo/plone-docs
>
> ------------------------------------------------------------------------------
> Achieve Improved Network Security with IP and DNS Reputation.
> Defend against bad network traffic, including botnets, malware,
> phishing sites, and compromised hosts - saving your company time,
> money, and embarrassment.   Learn More!
> http://p.sf.net/sfu/hpdev2dev-nov

Re: [Plone-docs] Integrating comments back to the docs

[Dylan J. <dy...@dy...>]

On 03/11/2010, at 7:11 AM, Alan Runyan <ru...@gm...> wrote:

>> Jörg was asking in the conference to get discussion back to the
>> developers docs, as for example php.net the discussion is very active
>> and the you can easily find ready made recipes for your problems. We
>> also discussed shortly with Timo should we use plone.app.discussion or
>> Disqus for this.
>>
>> Now someone has set us an example to go forward:
>>
>> http://www.zodb.org/zodbbook/
>
> +1 to sphinx/disqus approach.  if plone.app.discussion provides a UI like disqus
> then maybe we could move to that.  but until there is:
>  - ReST API / HTML/JS integration
>  - Comment moderation UI
>  - Ability to use p.a.d outside of Plone stack (i.e. from Sphinx); I believe
>  the sphinx+disqus approach is best, for now.

But the home of the dev docs is now plone.org which is published using
plone even if the content is generated via sphinx. But since we are no
longer deleting content during that upload process we can just use
p.a.discussion right?

>
> now plone.app.discussion can BEAT disqus in features and ease of integration ;-)
> they have a target.  timmo and crew are smart.  lets see if they can change ppl
> mind.
>
> competition is good.
>
> alan
>
> ------------------------------------------------------------------------------
> Nokia and AT&T present the 2010 Calling All Innovators-North America contest
> Create new apps & games for the Nokia N8 for consumers in  U.S. and Canada
> $10 million total in prizes - $4M cash, 500 devices, nearly $6M in marketing
> Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi Store
> http://p.sf.net/sfu/nokia-dev2dev
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs

Re: [Plone-docs] Integrating comments back to the docs

[Dylan J. <dy...@dy...>]

On 03/11/2010, at 7:11 AM, Alan Runyan <ru...@gm...> wrote:

>> Jörg was asking in the conference to get discussion back to the
>> developers docs, as for example php.net the discussion is very active
>> and the you can easily find ready made recipes for your problems. We
>> also discussed shortly with Timo should we use plone.app.discussion or
>> Disqus for this.
>>
>> Now someone has set us an example to go forward:
>>
>> http://www.zodb.org/zodbbook/
>
> +1 to sphinx/disqus approach.  if plone.app.discussion provides a UI like disqus
> then maybe we could move to that.  but until there is:
>  - ReST API / HTML/JS integration
>  - Comment moderation UI
>  - Ability to use p.a.d outside of Plone stack (i.e. from Sphinx); I believe
>  the sphinx+disqus approach is best, for now.
>
> now plone.app.discussion can BEAT disqus in features and ease of integration ;-)
> they have a target.  timmo and crew are smart.  lets see if they can change ppl
> mind.
>
> competition is good.
>
> alan
>
> ------------------------------------------------------------------------------
> Nokia and AT&T present the 2010 Calling All Innovators-North America contest
> Create new apps & games for the Nokia N8 for consumers in  U.S. and Canada
> $10 million total in prizes - $4M cash, 500 devices, nearly $6M in marketing
> Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi Store
> http://p.sf.net/sfu/nokia-dev2dev
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs