Up to date Zope documentation?
Hi, I'm starting work on a Problem-Based Learning application based on Zope. I'm very impressed with Zope from what I've seen so far. However, now that I'm beginning development, I need up to date documentation. I have a copy of the Zope Book V2.6 pdf, but I'm wondering how useful it will be given that the current version of Zope is 2.7. Obviously old documentation is better than none at all, but will a more up to date version of the Zope Book be forthcoming, or will the move towards Zope 3 make this unlikely? Also, the Zope Developers Guide on zope.org is version 2.4. Am I right in thinking that this is a guide for Zope 2.4, rather than version 2.4 of the Guide? Perhaps the ZDG has been incorporated into versino 2.6 of the Zope Book? I have a similar question regarding the Zope Administrator's Guide Project. The project has stalled since Jan 2002, according to http://zope.org/DocProjects/AdminGuide/Project/FrontPage Are the necessary resources available as part of v2.6 of the Zope Book? Regards, Cormac. ______________________________________________________________________ This email has been scanned by the MessageLabs Email Security System. For more information please visit http://www.messagelabs.com/email ______________________________________________________________________
On Fri, 2 Apr 2004, Cormac McClean wrote:
However, now that I'm beginning development, I need up to date documentation. I have a copy of the Zope Book V2.6 pdf, but I'm wondering how useful it will be given that the current version of Zope is 2.7. I'm not sure whether the PDF is a daily build, however for building the Debian packages I check out the "source" with the script appended to the end of this mail. If you apply the diff available at
http://ftp.debian.org/debian/pool/main/z/zope-book/zope-book_20040401-1.diff... you have all things to build your own plain HTML or PDF even if not using Debian GNU/Linux, where 'apt-get install zope-book' is enough. It was updated yesterday by chance...
Also, the Zope Developers Guide on zope.org is version 2.4. Am I right in thinking that this is a guide for Zope 2.4, rather than version 2.4 of the Guide? Perhaps the ZDG has been incorporated into versino 2.6 of the Zope Book? I think not and it's a shame that it is this outdated.
I have a similar question regarding the Zope Administrator's Guide Project. The project has stalled since Jan 2002, according to http://zope.org/DocProjects/AdminGuide/Project/FrontPage I think it is even worse.
Kind regards Andreas. #!/bin/sh ## Script to obtain current zope book stx + images NAME=zope-book MAINBASE=zope.org/Documentation/Books/ZopeBook/2_6Edition MAIN=http://www.${MAINBASE} URLS=http://${MAINBASE} DATE=`date +%Y%m%d` DIR=${NAME}-${DATE} TAR=${DIR}.tar.gz mkdir -p ${DIR} cd ${DIR} # get stx # wget -N http://www.zope.org/Documentation/Books/ZopeBook/2_6Edition/index_html # wget -N http://zope.org/Documentation/Books/ZopeBook/2_6Edition/ wget -N -q http://www.zope.org/Documentation/Books/ZopeBook/current mv view index_html echo "Downloading stx-files ..." cat index_html | \ grep "\.stx" | \ sed -e "s?^.*\(http://\)?echo -n '.'; wget -N -q \1?" \ -e "s?\([^/]*\.stx\).*?\1/document_src; mv document_src \1?" | \ cat > getstx chmod 755 getstx ./getstx rm getstx echo "" for stx in `ls *.stx` ; do # remove ^M and backtalk comments mv ${stx} ${stx}~ cat ${stx}~ | \ perl -pe 's/\r//g' | \ sed "/^[[:space:]]\+% [[:alnum:][:space:]_]\+ - [[:alnum:]]\{3,4\}\.* [0-9]\+, [0-9]\{4\} [0-9]\+:[0-9]\+/,/^$/d" | \ cat > ${stx} rm ${stx}~ done if grep -q "^[[:space:]]\+% " *.stx ; then echo "Some remaing comments found ..." grep "^[[:space:]]\+% " *.stx fi # get figures fig=Figures mkdir -p ${fig} grep "img" *.stx > ${fig}/imgs cd ${fig} cat imgs | \ grep ${fig} | \ sed -e "s?^.*\(${fig}\)/?echo -n '.'; wget -N -q ${MAIN}/\1/?" | \ sort | uniq | \ cat > figures chmod 755 figures echo "Downloading images ..." ./figures echo "" rm imgs figures if file -b -i * | sort | uniq | grep -q -v "^image" ; then echo "It seems that there where some files downloaded which are no images ..." file -i * | sort | grep -v ":[[:space:]]\+image" echo "I'm going to move these files to directory Non-${fig}." mkdir ../Non-${fig} ## some strange characters avoid propper moving so fix this first ... mv login_form* ../Non-${fig} for nonimg in `file -i * | grep -v ":[[:space:]]\+image" | sed "s/:.*//"` ; do mv "$nonimg" ../Non-${fig} done fi cd .. # get css and js #grep "http.*backtalk" index_html | \ # grep -v backtalk.book_pdf_form | \ # grep -v backtalk.book_view | \ # sed -e "s?^.*[fc]=\"\(.*\)\".*?wget -N \1?" \ # -e "s/.*\(backtalk\)_\(.*\)/&; mv \1_\2 \1.\2/" | \ # uniq | \ #cat > getstyle # #grep "\.css\"" index_html | \ # sed -e "s?^.*[fc]=\"\(.*\)\".*?wget -N \1?" | \ #cat >> getstyle #chmod 755 getstyle # #./getstyle #[ -s plonePrint.css ] && ln -s plonePrint.css backtalk.css #rm ./getstyle wget -N -q http://zope.org/plone.css # get Zope button image wget -N -q http://www.zope.org/p_/ZopeButton mv ZopeButton ZopeButton.jpg # prepare index.html cat index_html | \ sed -e "s?${URLS}/\(.*\.\)stx?\1html?g" \ -e "s?${URLS}/\(backtalk\)_?\1.?" | \ perl -ne '$f=1; chomp; s/\r//; print "$_\n" ; while (<>) { chomp; s/\r//; if ($f) { print "$_\n"; if (/<body>/) {$f=0 ;} } if (!$f) { if (/<b>The Zope Book/) { print "$_\n"; } if (/<table class="listing">/) { $f=1; } } }' | \ sed -e "/<thead>/,/<.thead>/d" \ -e "s/<tbody>/<table>/" \ -e "/<base href=\"http:/d" \ -e "/<\/tbody>/d" | \ perl -ne '$f=1; chomp; print "$_\n" ; while (<>) { if ($f) { print "$_\n"; if (?</table>?) {$f=0 ;} } if (!$f && ?</body>?) { print "$_\n"; $f=1; } }' | \ perl -ne '$f=1; chomp; print "$_\n" ; while (<>) { if ($f) { print "$_\n"; if (?</title>?) {$f=0 ;} } if (!$f && ?</head>?) { print "<link rel=\"StyleSheet\" href=\"plone.css\" type=\"text/css\">\n" ; print "$_\n"; $f=1; } }' | \ cat > index.html rm index_html cd .. tar -czf ${TAR} ${DIR}
Hi Andreas, Many thanks for your detailed reply. As it happens I use Knoppix and should be able to apt-get the latest version of the Zope Book - I didn't know it was available in this format. Many thanks, Cormac. Andreas Tille wrote:
On Fri, 2 Apr 2004, Cormac McClean wrote:
However, now that I'm beginning development, I need up to date documentation. I have a copy of the Zope Book V2.6 pdf, but I'm wondering how useful it will be given that the current version of Zope is 2.7.
I'm not sure whether the PDF is a daily build, however for building the Debian packages I check out the "source" with the script appended to the end of this mail. If you apply the diff available at
http://ftp.debian.org/debian/pool/main/z/zope-book/zope-book_20040401-1.diff...
you have all things to build your own plain HTML or PDF even if not using Debian GNU/Linux, where 'apt-get install zope-book' is enough. It was updated yesterday by chance...
Also, the Zope Developers Guide on zope.org is version 2.4. Am I right in thinking that this is a guide for Zope 2.4, rather than version 2.4 of the Guide? Perhaps the ZDG has been incorporated into versino 2.6 of the Zope Book?
I think not and it's a shame that it is this outdated.
I have a similar question regarding the Zope Administrator's Guide Project. The project has stalled since Jan 2002, according to http://zope.org/DocProjects/AdminGuide/Project/FrontPage
I think it is even worse.
Kind regards
Andreas.
#!/bin/sh ## Script to obtain current zope book stx + images
NAME=zope-book MAINBASE=zope.org/Documentation/Books/ZopeBook/2_6Edition MAIN=http://www.${MAINBASE} URLS=http://${MAINBASE}
DATE=`date +%Y%m%d` DIR=${NAME}-${DATE} TAR=${DIR}.tar.gz
mkdir -p ${DIR} cd ${DIR}
# get stx # wget -N http://www.zope.org/Documentation/Books/ZopeBook/2_6Edition/index_html # wget -N http://zope.org/Documentation/Books/ZopeBook/2_6Edition/ wget -N -q http://www.zope.org/Documentation/Books/ZopeBook/current mv view index_html echo "Downloading stx-files ..." cat index_html | \ grep "\.stx" | \ sed -e "s?^.*\(http://\)?echo -n '.'; wget -N -q \1?" \ -e "s?\([^/]*\.stx\).*?\1/document_src; mv document_src \1?" | \ cat > getstx chmod 755 getstx ./getstx rm getstx echo ""
for stx in `ls *.stx` ; do # remove ^M and backtalk comments mv ${stx} ${stx}~ cat ${stx}~ | \ perl -pe 's/\r//g' | \ sed "/^[[:space:]]\+% [[:alnum:][:space:]_]\+ - [[:alnum:]]\{3,4\}\.* [0-9]\+, [0-9]\{4\} [0-9]\+:[0-9]\+/,/^$/d" | \ cat > ${stx} rm ${stx}~ done
if grep -q "^[[:space:]]\+% " *.stx ; then echo "Some remaing comments found ..." grep "^[[:space:]]\+% " *.stx fi
# get figures fig=Figures
mkdir -p ${fig} grep "img" *.stx > ${fig}/imgs cd ${fig} cat imgs | \ grep ${fig} | \ sed -e "s?^.*\(${fig}\)/?echo -n '.'; wget -N -q ${MAIN}/\1/?" | \ sort | uniq | \ cat > figures
chmod 755 figures echo "Downloading images ..." ./figures echo "" rm imgs figures
if file -b -i * | sort | uniq | grep -q -v "^image" ; then echo "It seems that there where some files downloaded which are no images ..." file -i * | sort | grep -v ":[[:space:]]\+image" echo "I'm going to move these files to directory Non-${fig}." mkdir ../Non-${fig} ## some strange characters avoid propper moving so fix this first ... mv login_form* ../Non-${fig} for nonimg in `file -i * | grep -v ":[[:space:]]\+image" | sed "s/:.*//"` ; do mv "$nonimg" ../Non-${fig} done fi cd ..
# get css and js #grep "http.*backtalk" index_html | \ # grep -v backtalk.book_pdf_form | \ # grep -v backtalk.book_view | \ # sed -e "s?^.*[fc]=\"\(.*\)\".*?wget -N \1?" \ # -e "s/.*\(backtalk\)_\(.*\)/&; mv \1_\2 \1.\2/" | \ # uniq | \ #cat > getstyle # #grep "\.css\"" index_html | \ # sed -e "s?^.*[fc]=\"\(.*\)\".*?wget -N \1?" | \ #cat >> getstyle #chmod 755 getstyle # #./getstyle #[ -s plonePrint.css ] && ln -s plonePrint.css backtalk.css #rm ./getstyle wget -N -q http://zope.org/plone.css
# get Zope button image wget -N -q http://www.zope.org/p_/ZopeButton mv ZopeButton ZopeButton.jpg
# prepare index.html cat index_html | \ sed -e "s?${URLS}/\(.*\.\)stx?\1html?g" \ -e "s?${URLS}/\(backtalk\)_?\1.?" | \ perl -ne '$f=1; chomp; s/\r//; print "$_\n" ; while (<>) { chomp; s/\r//; if ($f) { print "$_\n"; if (/<body>/) {$f=0 ;} } if (!$f) { if (/<b>The Zope Book/) { print "$_\n"; } if (/<table class="listing">/) { $f=1; } } }' | \ sed -e "/<thead>/,/<.thead>/d" \ -e "s/<tbody>/<table>/" \ -e "/<base href=\"http:/d" \ -e "/<\/tbody>/d" | \ perl -ne '$f=1; chomp; print "$_\n" ; while (<>) { if ($f) { print "$_\n"; if (?</table>?) {$f=0 ;} } if (!$f && ?</body>?) { print "$_\n"; $f=1; } }' | \ perl -ne '$f=1; chomp; print "$_\n" ; while (<>) { if ($f) { print "$_\n"; if (?</title>?) {$f=0 ;} } if (!$f && ?</head>?) { print "<link rel=\"StyleSheet\" href=\"plone.css\" type=\"text/css\">\n" ; print "$_\n"; $f=1; } }' | \ cat > index.html
rm index_html
cd ..
tar -czf ${TAR} ${DIR}
_______________________________________________ Zope maillist - Zope@zope.org http://mail.zope.org/mailman/listinfo/zope ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope-dev )
______________________________________________________________________ This email has been scanned by the MessageLabs Email Security System. For more information please visit http://www.messagelabs.com/email ______________________________________________________________________
______________________________________________________________________ This email has been scanned by the MessageLabs Email Security System. For more information please visit http://www.messagelabs.com/email ______________________________________________________________________
On Fri, 2 Apr 2004, Cormac McClean wrote:
Many thanks for your detailed reply. As it happens I use Knoppix and should be able to apt-get the latest version of the Zope Book - I didn't know it was available in this format. You should "apt-get search" from time to time. For instance besides some noise
apt-cache search zope documentation has something you might be interested in. Kind regards Andreas.
Unfortunately, there are no "real" plans to update the Zope Book for 2.7+. It's something I would like to do (or at least organize), but I've not been able to find the time to do it since 2.7 was released. It is something that will likely happen, eventually, but I can't name dates at the moment. On Fri, 2004-04-02 at 04:53, Cormac McClean wrote:
Hi,
I'm starting work on a Problem-Based Learning application based on Zope. I'm very impressed with Zope from what I've seen so far.
However, now that I'm beginning development, I need up to date documentation. I have a copy of the Zope Book V2.6 pdf, but I'm wondering how useful it will be given that the current version of Zope is 2.7. Obviously old documentation is better than none at all, but will a more up to date version of the Zope Book be forthcoming, or will the move towards Zope 3 make this unlikely?
Also, the Zope Developers Guide on zope.org is version 2.4. Am I right in thinking that this is a guide for Zope 2.4, rather than version 2.4 of the Guide? Perhaps the ZDG has been incorporated into versino 2.6 of the Zope Book?
I have a similar question regarding the Zope Administrator's Guide Project. The project has stalled since Jan 2002, according to http://zope.org/DocProjects/AdminGuide/Project/FrontPage
Are the necessary resources available as part of v2.6 of the Zope Book?
Regards, Cormac.
______________________________________________________________________ This email has been scanned by the MessageLabs Email Security System. For more information please visit http://www.messagelabs.com/email ______________________________________________________________________
_______________________________________________ Zope maillist - Zope@zope.org http://mail.zope.org/mailman/listinfo/zope ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope-dev )
I've been planning to update the Zope book for 2.7 for some time now -- at least the Installation and Maintainance chapters -- but was unable to do so due to getting constantly swamped with work :-/ But I hope to get around to writing an updated Installation chapter Real Soon Now (tm) Chris McDonough wrote:
Unfortunately, there are no "real" plans to update the Zope Book for 2.7+. It's something I would like to do (or at least organize), but I've not been able to find the time to do it since 2.7 was released. It is something that will likely happen, eventually, but I can't name dates at the moment.
On Fri, 2004-04-02 at 04:53, Cormac McClean wrote:
Hi,
I'm starting work on a Problem-Based Learning application based on Zope. I'm very impressed with Zope from what I've seen so far.
However, now that I'm beginning development, I need up to date documentation. I have a copy of the Zope Book V2.6 pdf, but I'm wondering how useful it will be given that the current version of Zope is 2.7. Obviously old documentation is better than none at all, but will a more up to date version of the Zope Book be forthcoming, or will the move towards Zope 3 make this unlikely?
Also, the Zope Developers Guide on zope.org is version 2.4. Am I right in thinking that this is a guide for Zope 2.4, rather than version 2.4 of the Guide? Perhaps the ZDG has been incorporated into versino 2.6 of the Zope Book?
I have a similar question regarding the Zope Administrator's Guide Project. The project has stalled since Jan 2002, according to http://zope.org/DocProjects/AdminGuide/Project/FrontPage
Are the necessary resources available as part of v2.6 of the Zope Book?
Regards, Cormac.
______________________________________________________________________ This email has been scanned by the MessageLabs Email Security System. For more information please visit http://www.messagelabs.com/email ______________________________________________________________________
_______________________________________________ Zope maillist - Zope@zope.org http://mail.zope.org/mailman/listinfo/zope ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope-dev )
_______________________________________________ Zope maillist - Zope@zope.org http://mail.zope.org/mailman/listinfo/zope ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope-dev )
On Saturday 03 April 2004 01:05, Chris McDonough wrote:
Unfortunately, there are no "real" plans to update the Zope Book for 2.7+. It's something I would like to do (or at least organize), but I've not been able to find the time to do it since 2.7 was released. It is something that will likely happen, eventually, but I can't name dates at the moment.
hey there long time no hear i'd like to do zeo chapter, but am not sure whether this[1] still hold water :P if you think this is ok, ill try and redo to fit zope book. thanks [1]http://www.my-zope.org/Members/kedai/News_Item.2003-11-15.5611
Hello Bakhtiar, That looks mostly correct, although I'm not 100% certain. Since nobody who cares really knows, I think one of the tasks is to get enough information to convince yourself of "the right way" to set up ZEO under Zope 2.7+ and become the expert. ;-) Would you be willing to do that? - C On Fri, 2004-04-23 at 06:00, Bakhtiar A Hamid wrote:
On Saturday 03 April 2004 01:05, Chris McDonough wrote:
Unfortunately, there are no "real" plans to update the Zope Book for 2.7+. It's something I would like to do (or at least organize), but I've not been able to find the time to do it since 2.7 was released. It is something that will likely happen, eventually, but I can't name dates at the moment.
hey there long time no hear
i'd like to do zeo chapter, but am not sure whether this[1] still hold water :P
if you think this is ok, ill try and redo to fit zope book.
thanks
[1]http://www.my-zope.org/Members/kedai/News_Item.2003-11-15.5611
_______________________________________________ Zope maillist - Zope@zope.org http://mail.zope.org/mailman/listinfo/zope ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope-dev )
Cormac McClean wrote at 2004-4-2 10:53 +0100:
... However, now that I'm beginning development, I need up to date documentation. I have a copy of the Zope Book V2.6 pdf, but I'm wondering how useful it will be given that the current version of Zope is 2.7. Obviously old documentation is better than none at all, but will a more up to date version of the Zope Book be forthcoming, or will the move towards Zope 3 make this unlikely?
I do not expect that the book will stay up to date with the software. In my view, this is no big problem. Almost everything, you read in the book is still valid for Zope 2.7. The only major change in Zope 2.7 is installation and configuration. Installation is very simple and configuration is very good documented in the default configuration file.
Also, the Zope Developers Guide on zope.org is version 2.4. Am I right in thinking that this is a guide for Zope 2.4, rather than version 2.4 of the Guide? Perhaps the ZDG has been incorporated into versino 2.6 of the Zope Book?
Almost nothing changed for developers between Zope 2.4 and Zope 2.7. Of course, you have more products (e.g. "Sessions", "SiteAccess", "OrderedFolder", ...). But they would be documented anyway for themselves.
I have a similar question regarding the Zope Administrator's Guide Project. The project has stalled since Jan 2002, according to http://zope.org/DocProjects/AdminGuide/Project/FrontPage
Are the necessary resources available as part of v2.6 of the Zope Book?
I do not know. I never read this guide. Zope administration is really trivial. Personally, I do not see the need for a guide. -- Dieter
participants (6)
-
Andreas Tille -
Bakhtiar A Hamid -
Chris McDonough -
Cormac McClean -
Dieter Maurer -
Peter Sabaini