Plone 3.2 User Manual Update
|
|
| 1 2 |
|
Jeff Pittman
()
Plone 3.2 User Manual Update
|
|
||||||||||||
|
I am interested in working on a Plone 3.2 version of the user manual.
One way of doing it is to copy the 3.0 version (manual content type in
PHC), then modifying in place for 3.2. That's what we did when we made
a 3.0 manual from the 2.5 version. Steve, iirc, you did something
special to copy it?
New screen captures, updated text, and replacement screencasts will be needed. The screencasts are stored outside of the manual, on Plone's media server. I have Screenflow for making screencasts, and I think these are really important to weave into the user manual, even more than we did for the previous versions. Sam, I've been meaning to ask you about your current screencast-making routine -- Veda mentioned jing... Jeff Jeff Pittman http://www.geojeff.org ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
JoAnna Springsteen
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
I would really really like to avoid having a 3.0 manual and a 3.2
manual and then a 3.5 manual and then a 3.7 manual etc. I think that's overkill. That being said, updating the 3.0 manual isn't an issue. Just be careful to specific if something applies to 3.0 or 3.2 specifically. We can continue our pattern and create a new manual for 3.5. For now work with what exists. Also, I know Sam had some updates he wanted to make, not sure if he has started on them. Be sure to coordinate with Sam before starting on anything. On Sat, Dec 20, 2008 at 4:50 AM, Jeff Pittman <[hidden email]> wrote: > I am interested in working on a Plone 3.2 version of the user manual. One > way of doing it is to copy the 3.0 version (manual content type in PHC), > then modifying in place for 3.2. That's what we did when we made a 3.0 > manual from the 2.5 version. Steve, iirc, you did something special to copy > it? > > New screen captures, updated text, and replacement screencasts will be > needed. > > The screencasts are stored outside of the manual, on Plone's media server. I > have Screenflow for making screencasts, and I think these are really > important to weave into the user manual, even more than we did for the > previous versions. Sam, I've been meaning to ask you about your current > screencast-making routine -- Veda mentioned jing... > > Jeff > > Jeff Pittman > http://www.geojeff.org > > ------------------------------------------------------------------------------ > > _______________________________________________ > Plone-docs mailing list > [hidden email] > https://lists.sourceforge.net/lists/listinfo/plone-docs > > ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
The manual could be divided into its sections, storing the versions of
the sections by Plone version applicability, then having one single
user manual with a menu choice of which version to view. The sections
shown for a view of the user manual would be a best fit for the
requested version, accordingly. With each Plone release, sections would
need to be marked/updated. This is really how it should be done. Advice
and ideas are appreciated. One attractive possibility is to maintain
the user manual in straight python and directories/docs/images on the
filesystem.
I will, of course, coordinate with Sam and anyone else interested in the user manual. Jeff Jeff Pittman http://www.geojeff.org On Sat, Dec 20, 2008 at 10:43 AM, JoAnna Springsteen <[hidden email]> wrote: I would really really like to avoid having a 3.0 manual and a 3.2 ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
Also, at a recent sprint, there was an exploration of automation for screen captures for the user manual and other documentation needs. Brandon Rhodes and I looked at windmill (http://pypi.python.org/pypi/windmill/) briefly for the task, and noted that there are several ways this could be done. Automation of screen captures is very interesting, and would be a good fit for a maintenance of a python/filesystem approach.
Jeff Pittman http://www.geojeff.org On Sat, Dec 20, 2008 at 11:21 AM, Jeff Pittman <[hidden email]> wrote:
------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
JoAnna Springsteen
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by Jeff Pittman
On Sat, Dec 20, 2008 at 11:21 AM, Jeff Pittman <[hidden email]> wrote:
> The manual could be divided into its sections, storing the versions of the > sections by Plone version applicability, then having one single user manual > with a menu choice of which version to view. The sections shown for a view > of the user manual would be a best fit for the requested version, > accordingly. With each Plone release, sections would need to be > marked/updated. This is really how it should be done. Advice and ideas are > appreciated. Interesting. Any thoughts on how we could do this in PHC? SteveM, thoughts? One attractive possibility is to maintain the user manual in > straight python and directories/docs/images on the filesystem. eh, not too hot on this idea. Makes contributing that much harder for those who don't know python. ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
JoAnna Springsteen
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by Jeff Pittman
On Sat, Dec 20, 2008 at 11:38 AM, Jeff Pittman <[hidden email]> wrote:
> Also, at a recent sprint, there was an exploration of automation for screen > captures for the user manual and other documentation needs. Yup. Seems like we've been talking about this since the PSU symposium. I know Paul Everitt had thoughts on how this could be done too. Not sure if anything ever came of it though. Would still be interested in hearing how we could accomplish this without making it hugely complicated. ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by JoAnna Springsteen
Love the python.
The sections would be stored in svn?, so contributing wouldn't be a problem, eh? Jeff Jeff Pittman http://www.geojeff.org On Sat, Dec 20, 2008 at 12:15 PM, JoAnna Springsteen <[hidden email]> wrote:
------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
Steve McMahon
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by Jeff Pittman
There are supposed to be few to no user interface changes in the 3.x
series. In fact, the P3 Framework Team has turned down several PLIPs in order to avoid making any changes that would invalidate end-user documentation. 3.2 will require some installation documentation, as it obsoletes the old tarball installation method. But, that's pretty much it. So, I'd rather just have one 3.x manual. If though, you'd like to have a working copy to change in place, then use to replace the older 3.x manual, that's fine. Steve On Sat, Dec 20, 2008 at 2:50 AM, Jeff Pittman <[hidden email]> wrote: > I am interested in working on a Plone 3.2 version of the user manual. One > way of doing it is to copy the 3.0 version (manual content type in PHC), > then modifying in place for 3.2. That's what we did when we made a 3.0 > manual from the 2.5 version. Steve, iirc, you did something special to copy > it? > > New screen captures, updated text, and replacement screencasts will be > needed. > > The screencasts are stored outside of the manual, on Plone's media server. I > have Screenflow for making screencasts, and I think these are really > important to weave into the user manual, even more than we did for the > previous versions. Sam, I've been meaning to ask you about your current > screencast-making routine -- Veda mentioned jing... > > Jeff > > Jeff Pittman > http://www.geojeff.org > > ------------------------------------------------------------------------------ > > _______________________________________________ > Plone-docs mailing list > [hidden email] > https://lists.sourceforge.net/lists/listinfo/plone-docs > > -- Steve McMahon Reid-McMahon, LLC [hidden email] [hidden email] ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
JoAnna Springsteen
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by Jeff Pittman
On Sat, Dec 20, 2008 at 12:18 PM, Jeff Pittman <[hidden email]> wrote:
> Love the python. > > The sections would be stored in svn?, so contributing wouldn't be a problem, > eh? We're trying really really hard to adjust PHC to make it easier to manage our docs. The editors aren't real thrilled on the idea of managing docs in yet another way. Love it or hate it, PHC is here to stay. Of course, SteveM and others are working very hard to make PHC kinder and friendlier and more usable. And I believe they are still taking ideas. This is the direction we are pursuing for formal docs. Let's think of a way to do this within PHC. ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by JoAnna Springsteen
The screen capture facility would be accomplished, I imagine, with a driver script operating on hooks (special codes) in the docs to drive the browser and captures -- or such a script developed in parallel.
Regarding complication of such a system, having a driver system in python is not a bad thing -- we are a python house, ultimately. :) And, I wouldn't want us to shy away from innovation. Such an approach inherently requires an intelligent system, for which we are fully capable of designing and maintaining. It would be like other complicated python scripts I use on the command line -- a chore to build, but once they work, they become workhorse utilities. Jeff Jeff Pittman http://www.geojeff.org On Sat, Dec 20, 2008 at 12:18 PM, JoAnna Springsteen <[hidden email]> wrote:
------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Steve McMahon
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
Automating the screenshots is totally cool. It's the editable prose
that we'd like to keep inside the CMS, where it can be worked on by prose writers who aren't necessarily comfortable with svn and particular markup schemes. On Sat, Dec 20, 2008 at 10:31 AM, Jeff Pittman <[hidden email]> wrote: > The screen capture facility would be accomplished, I imagine, with a driver > script operating on hooks (special codes) in the docs to drive the browser > and captures -- or such a script developed in parallel. > > Regarding complication of such a system, having a driver system in python is > not a bad thing -- we are a python house, ultimately. :) > > And, I wouldn't want us to shy away from innovation. Such an approach > inherently requires an intelligent system, for which we are fully capable of > designing and maintaining. It would be like other complicated python > scripts I use on the command line -- a chore to build, but once they work, > they become workhorse utilities. > > Jeff > > Jeff Pittman > http://www.geojeff.org > > > On Sat, Dec 20, 2008 at 12:18 PM, JoAnna Springsteen <[hidden email]> > wrote: >> >> On Sat, Dec 20, 2008 at 11:38 AM, Jeff Pittman <[hidden email]> >> wrote: >> > Also, at a recent sprint, there was an exploration of automation for >> > screen >> > captures for the user manual and other documentation needs. >> >> Yup. Seems like we've been talking about this since the PSU symposium. >> I know Paul Everitt had thoughts on how this could be done too. >> Not sure if anything ever came of it though. >> Would still be interested in hearing how we could accomplish this >> without making it hugely complicated. > > > ------------------------------------------------------------------------------ > > _______________________________________________ > Plone-docs mailing list > [hidden email] > https://lists.sourceforge.net/lists/listinfo/plone-docs > > -- Steve McMahon Reid-McMahon, LLC [hidden email] [hidden email] ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
Yes, keeping the editable prose in Plone is the way to go -- sorry to have suggested svn for this.
For developing a system of updating the screen captures and other analytical/update work done independently on the user manual -- independent of the standard prose editing in place on plone.org -- the html of the prose could be grabbed over the top with a scrape, or via a custom script on plone.org. A python/filesystem approach could be developed in parallel for doing the automation by parsing the html/restructured text. A parallel html version of the user manual could be rendered on the desktop for inspection as you work on the screen captures, and fresh images/media could be uploaded in bulk when done. Jeff Jeff Pittman http://www.geojeff.org On Sat, Dec 20, 2008 at 12:41 PM, Steve McMahon <[hidden email]> wrote: Automating the screenshots is totally cool. It's the editable prose ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
Hmm... could the prose of the user manual contain hooks in hidden comments in an unobtrusive way (invisible to editors)?
Jeff Jeff Pittman http://www.geojeff.org On Sat, Dec 20, 2008 at 1:29 PM, Jeff Pittman <[hidden email]> wrote: Yes, keeping the editable prose in Plone is the way to go -- sorry to have suggested svn for this. ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
Using urllib2 and BeautifulSoup, can now pull and parse a manual and all its pages for title, description, body text html tags...
Jeff Jeff Pittman http://www.geojeff.org On Sat, Dec 20, 2008 at 1:36 PM, Jeff Pittman <[hidden email]> wrote: Hmm... could the prose of the user manual contain hooks in hidden comments in an unobtrusive way (invisible to editors)? ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
Alexander Limi
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by Jeff Pittman
On Sat, 20 Dec 2008 02:50:39 -0800, Jeff Pittman
<[hidden email]> wrote: > I am interested in working on a Plone 3.2 version of the user manual. One > way of doing it is to copy the 3.0 version (manual content type in PHC), > then modifying in place for 3.2. That's what we did when we made a 3.0 > manual from the 2.5 version. Steve, iirc, you did something special to > copy > it? I just want to echo what Steve said earlier — if there is a need for a separate 3.2 manual, then 3.2 is not a successful release. The whole idea about the 3.x line is that interface stability is paramount, if you sit down in front of Plone 3.0 or 3.2 or 3.7, it shouldn't matter. Yes, this means that we can't improve the UI in a significant way in the 3.x series, but even I can see that this is for the better, and swallow my UI pride and put that energy towards Plone 4 instead. :) In general, we should strive to talk about "Plone 3" wherever possible, not "Plone 3.2" or "Plone 3.1". I have made this same mistake several times in documentation and other pages, but I try to correct it whenever I stumble over it in the existing docs. > New screen captures, updated text, and replacement screencasts will be > needed. Hopefully not. -- Alexander Limi · http://limi.net ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
Sorry, I had the mistaken idea that the user interface changes in the 3.1 series were significant, but I see now -- the UI has been stable -- good job Plone!
There are a few little things that have changed, but nothing really serious that we can't edit in place in the existing Plone 3 manual. And I can see where work on an updated user manual should target the Plone 4 series. The short name of the manual is plone-3-user-manual, but the title is Plone 3.0 User Manual. The title would be fine, better in fact, as Plone 3 User Manual. Should we change it? Implications for links to the manual? (we would be changing title, not short name). Here are comments from a comparison of 3.0 to 3.1.7 user interface differences, and update needs to 3.0 user manual. See mentions of CHANGED for a few things. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/introduction/conceptual-overview OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/introduction/visual-design-of-plone-web-sites CHANGED Sites showcased with screen captures are: http://www.akamai.com/ -- significantly different now. Still Plone? http://discovermagazine.com/ -- significantly different now. Still Plone? http://www.smeal.psu.edu/ -- Looks the same. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/introduction/plone-user-accounts OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/introduction/setting-your-preferences http://plone.org/documentation/manual/plone-3-user-manual/introduction/your-dashboard CHANGED Default dashboard now shows Recent Changes portlet. (It was empty initially in 3.0). There is now a Change Password link between Profile and Personal Preferences links. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-folders CHANGED Add new drop-down menu has lost the bottom menu item, Page Restrictions... Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/whats-in-a-web-name OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-images OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/preparing-images-for-the-web OK Note: This page is linked at the top of the adding-images page, and is a page that repeats later. OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-pages OK Kupu menu bar is even the same, which is surprising. Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-files OK Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-links OK Screencasts (2) are for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-events OK Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-news-items OK Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/setting-basic-properties OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/adding-content/restricting-types-in-a-folder CHANGED As this has been removed from the Add new drop-down menu, this could just be deleted? Besides, I can't even find this functionality in another place? >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/cutting-copying-and-pasting-items OK Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/editing-content OK Checked mouse-over actions to trigger editing on a page, for the title and body text. OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/folder-view OK Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/folder-contents OK Screencast is for Plone 2.0, as warned on the page. Comment on the page: drag-drop reordering -- folder contents is the only place you can do reordering within a folder, but if you have a folder with more than 20 items you can't seem to do this cause of the next/previous page issue. Is there a way to display all items in a folder to allow full ordering control ? Added comment to say that reordering info is on the next page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/reordering-items OK Several comments on the page, for workarounds to reorder more than 20 items. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/previous-next-links OK I didn't see the Default/Categorization/Dates/Ownership/Settings panel for editing a folder, but then I realized I was trying it on the home folder, which must be different. I created a test folder and added some pages, enabled previous-next, and it worked fine. There are interesting comments on this page about problems, but one comment says "solved" and describes the effects of Apache proxying, etc. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/deleting-items OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/locking-and-unlocking-3-0 OK I've seen the unlock panel pop up on recent Plone 3.1 sites and it seems to work the same. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/managing-content/working-copy-3-0 http://plone.org/documentation/manual/plone-3-user-manual/managing-content/versioning These are Darci's pages, for functionality I haven't used yet -- I assume screen captures are still valid (didn't check). >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/using-collections/introduction-to-collections OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/using-collections/adding-collections OK Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/using-collections/adjusting-the-display-settings http://plone.org/documentation/manual/plone-3-user-manual/using-collections/definition-of-criteria http://plone.org/documentation/manual/plone-3-user-manual/using-collections/sort-order http://plone.org/documentation/manual/plone-3-user-manual/using-collections/using-and-understanding-dates http://plone.org/documentation/manual/plone-3-user-manual/portlet-management/portlet-hierarchy http://plone.org/documentation/manual/plone-3-user-manual/portlet-management/managing-portlets http://plone.org/documentation/manual/plone-3-user-manual/portlet-management/portlet-types CHANGED (ADDED) Aha! This is what Sam wanted to do -- he added these pages in November, 2008. Good job Sam! >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/publication-workflow-and-collaboration/basic-publication-states OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/publication-workflow-and-collaboration/advanced-control OK Screencast is for Plone 2.0, as warned on the page. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/publication-workflow-and-collaboration/workflow-policies OK >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/publication-workflow-and-collaboration/collaboration-through-sharing Comment on page: How would you prevent people who are not logged in to view the content of a directory of a file in a directory? Reply added. See http://plone.org/documentation/how-to/make-folder-hierarchy-private. >>>>><<<<< http://plone.org/documentation/manual/plone-3-user-manual/next-steps/other-useful-basic-documentation http://plone.org/documentation/manual/plone-3-user-manual/next-steps/from-user-to-site-administrator-and-beyond OK Jeff Pittman http://www.geojeff.org On Sun, Dec 21, 2008 at 9:40 PM, Alexander Limi <[hidden email]> wrote:
------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
vedaw
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by Jeff Pittman
Some javascript/style in this post has been disabled (why?)
And yes, screencasts would be great. I’m leaning towards using the media server, as plone.tv doesn’t allow videos to be shown at their full resolution and thus don’t have a lot of value. I believe that Nate Aune is working on this, but we should have an alternate plan in place. - Veda On 12/20/08 2:50 AM, "Jeff Pittman" <[hidden email]> wrote: I am interested in working on a Plone 3.2 version of the user manual. One way of doing it is to copy the 3.0 version (manual content type in PHC), then modifying in place for 3.2. That's what we did when we made a 3.0 manual from the 2.5 version. Steve, iirc, you did something special to copy it? ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
Jeff Pittman
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
Yes, see the previous post. I went through the changes, so no 3.2 manual is needed.
New screencasts would be great, and there are a few things to fix/update in the existing 3 manual. Jeff Jeff Pittman http://www.geojeff.org On Mon, Dec 22, 2008 at 11:30 AM, Veda Williams <[hidden email]> wrote:
------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
vedaw
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
In reply to this post
by Jeff Pittman
Some javascript/style in this post has been disabled (why?)
I’m a little hesitant to change the URLs for some of these until we have the 3.0 URL redirection working for us. Since this is coming very soon, I’d like to hold off on changing these until SteveM and I have a chance to work our magic. - Veda On 12/22/08 2:46 AM, "Jeff Pittman" <[hidden email]> wrote: Sorry, I had the mistaken idea that the user interface changes in the 3.1 series were significant, but I see now -- the UI has been stable -- good job Plone! ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
|
|
JoAnna Springsteen
()
Re: Plone 3.2 User Manual Update
|
|
||||||||||||
|
Yeah I haven't had a chance yet to read through Jeff's incredibly
thorough list. In general, if we want to redo the screencasts just to update them, then that's great. As Limi said, there shouldn't be any real need to do so because of UI updates. But if we want to make improvements then that's great. Same thing with text. Definitely don't need an entire separate manual just for 3.2. As far as URLs changing and such, let's wait on that as well. Anything that is technical concerning plone.org itself is best left until after we are upgraded. (which should be next week?!?!?) On Mon, Dec 22, 2008 at 12:06 PM, Veda Williams <[hidden email]> wrote: > Joanna, Sam, I assume you guys can work through this stuff and make changes > where necessary? > > I'm a little hesitant to change the URLs for some of these until we have the > 3.0 URL redirection working for us. Since this is coming very soon, I'd like > to hold off on changing these until SteveM and I have a chance to work our > magic. > > - Veda > > > On 12/22/08 2:46 AM, "Jeff Pittman" <[hidden email]> wrote: > > Sorry, I had the mistaken idea that the user interface changes in the 3.1 > series were significant, but I see now -- the UI has been stable -- good job > Plone! > > There are a few little things that have changed, but nothing really serious > that we can't edit in place in the existing Plone 3 manual. And I can see > where work on an updated user manual should target the Plone 4 series. > > The short name of the manual is plone-3-user-manual, but the title is Plone > 3.0 User Manual. The title would be fine, better in fact, as Plone 3 User > Manual. Should we change it? Implications for links to the manual? (we would > be changing title, not short name). > > Here are comments from a comparison of 3.0 to 3.1.7 user interface > differences, and update needs to 3.0 user manual. See mentions of CHANGED > for a few things. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/introduction/conceptual-overview > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/introduction/visual-design-of-plone-web-sites > > CHANGED > > Sites showcased with screen captures are: > > http://www.akamai.com/ -- significantly different now. Still Plone? > > http://discovermagazine.com/ -- significantly different now. Still Plone? > > http://www.smeal.psu.edu/ -- Looks the same. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/introduction/plone-user-accounts > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/introduction/setting-your-preferences > http://plone.org/documentation/manual/plone-3-user-manual/introduction/your-dashboard > > CHANGED > > Default dashboard now shows Recent Changes portlet. (It was empty initially > in 3.0). > > There is now a Change Password link between Profile and Personal Preferences > links. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-folders > > CHANGED > > Add new drop-down menu has lost the bottom menu item, Page Restrictions... > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/whats-in-a-web-name > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-images > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/preparing-images-for-the-web > > OK > > Note: This page is linked at the top of the adding-images page, and is a > page that repeats later. OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-pages > > OK Kupu menu bar is even the same, which is surprising. > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-files > > OK > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-links > > OK > > Screencasts (2) are for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-events > > OK > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/adding-news-items > > OK > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/setting-basic-properties > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/adding-content/restricting-types-in-a-folder > > CHANGED > > As this has been removed from the Add new drop-down menu, this could just be > deleted? > > Besides, I can't even find this functionality in another place? > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/cutting-copying-and-pasting-items > > OK > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/editing-content > > OK Checked mouse-over actions to trigger editing on a page, for the title > and body text. OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/folder-view > > OK > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/folder-contents > > OK > > Screencast is for Plone 2.0, as warned on the page. > > Comment on the page: drag-drop reordering -- folder contents is the only > place you can do reordering within a folder, but if you have a folder with > more than 20 items you can't seem to do this cause of the next/previous page > issue. Is there a way to display all items in a folder to allow full > ordering control ? > > Added comment to say that reordering info is on the next page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/reordering-items > > OK > > Several comments on the page, for workarounds to reorder more than 20 items. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/previous-next-links > > OK I didn't see the Default/Categorization/Dates/Ownership/Settings panel > for editing a folder, but then I realized I was trying it on the home > folder, which must be different. I created a test folder and added some > pages, enabled previous-next, and it worked fine. > > There are interesting comments on this page about problems, but one comment > says "solved" and describes the effects of Apache proxying, etc. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/deleting-items > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/locking-and-unlocking-3-0 > > OK I've seen the unlock panel pop up on recent Plone 3.1 sites and it seems > to work the same. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/working-copy-3-0 > http://plone.org/documentation/manual/plone-3-user-manual/managing-content/versioning > > These are Darci's pages, for functionality I haven't used yet -- I assume > screen captures are still valid (didn't check). > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/using-collections/introduction-to-collections > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/using-collections/adding-collections > > OK > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/using-collections/adjusting-the-display-settings > http://plone.org/documentation/manual/plone-3-user-manual/using-collections/definition-of-criteria > http://plone.org/documentation/manual/plone-3-user-manual/using-collections/sort-order > http://plone.org/documentation/manual/plone-3-user-manual/using-collections/using-and-understanding-dates > > http://plone.org/documentation/manual/plone-3-user-manual/portlet-management/portlet-hierarchy > http://plone.org/documentation/manual/plone-3-user-manual/portlet-management/managing-portlets > http://plone.org/documentation/manual/plone-3-user-manual/portlet-management/portlet-types > > CHANGED (ADDED) > > Aha! This is what Sam wanted to do -- he added these pages in November, > 2008. > > Good job Sam! > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/publication-workflow-and-collaboration/basic-publication-states > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/publication-workflow-and-collaboration/advanced-control > > OK > > Screencast is for Plone 2.0, as warned on the page. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/publication-workflow-and-collaboration/workflow-policies > > OK > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/publication-workflow-and-collaboration/collaboration-through-sharing > > Comment on page: How would you prevent people who are not logged in to view > the content of a directory of a file in a directory? > > Reply added. See > http://plone.org/documentation/how-to/make-folder-hierarchy-private. > >>>>>><<<<< > http://plone.org/documentation/manual/plone-3-user-manual/next-steps/other-useful-basic-documentation > http://plone.org/documentation/manual/plone-3-user-manual/next-steps/from-user-to-site-administrator-and-beyond > > OK > > Jeff Pittman > http://www.geojeff.org > > > On Sun, Dec 21, 2008 at 9:40 PM, Alexander Limi <[hidden email]> wrote: > > On Sat, 20 Dec 2008 02:50:39 -0800, Jeff Pittman > <[hidden email]> wrote: > >> I am interested in working on a Plone 3.2 version of the user manual. One >> way of doing it is to copy the 3.0 version (manual content type in PHC), >> then modifying in place for 3.2. That's what we did when we made a 3.0 >> manual from the 2.5 version. Steve, iirc, you did something special to >> copy >> it? > > I just want to echo what Steve said earlier — if there is a need for a > separate 3.2 manual, then 3.2 is not a successful release. The whole idea > about the 3.x line is that interface stability is paramount, if you sit > down in front of Plone 3.0 or 3.2 or 3.7, it shouldn't matter. > > Yes, this means that we can't improve the UI in a significant way in the > 3.x series, but even I can see that this is for the better, and swallow my > UI pride and put that energy towards Plone 4 instead. :) > > In general, we should strive to talk about "Plone 3" wherever possible, > not "Plone 3.2" or "Plone 3.1". I have made this same mistake several > times in documentation and other pages, but I try to correct it whenever I > stumble over it in the existing docs. > >> New screen captures, updated text, and replacement screencasts will be >> needed. > > Hopefully not. > > -- > Alexander Limi · http://limi.net > > > ------------------------------------------------------------------------------ > _______________________________________________ > Plone-docs mailing list > [hidden email] > https://lists.sourceforge.net/lists/listinfo/plone-docs > > > ________________________________ > ------------------------------------------------------------------------------ > ________________________________ > _______________________________________________ > Plone-docs mailing list > [hidden email] > https://lists.sourceforge.net/lists/listinfo/plone-docs > > > ------------------------------------------------------------------------------ > > _______________________________________________ > Plone-docs mailing list > [hidden email] > https://lists.sourceforge.net/lists/listinfo/plone-docs > > ------------------------------------------------------------------------------ _______________________________________________ Plone-docs mailing list [hidden email] https://lists.sourceforge.net/lists/listinfo/plone-docs |
||||||||||||||
| Free Embeddable Forum Powered by Nabble | Help |
