[Zope3-dev] Offer to Help Write User Documentation/Tutorials

[Jim Fulton]

Gary Poster wrote:
> 
> > I have Acrobat 5, which has good spidering facilities and leverages CSS.
> >   Thus I could produce a self-contained PDF if that would help people.
> >
> > --Paul
> 
> Thanks, Paul.  I have it too; when I have a sec later today I'll spit out
> what I have so far in Word into a pdf and see if anybody is interested or
> has feedback.  It's >70 pages at the moment, with *very* large sections not
> included yet.  Let no-one say Zope3 has no docs.  :-)
> 
> I initially tried spidering with wget but that proved to be grossly
> inefficient.  I would need to really do a careful wget setup to not download
> the backlinks, edit pages, etc. 

The trick is to point your slurper at the table of contents page or, better
yet, the offsprint of the front page:

http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/FrontPage/offspring

and tell it to go just one level.

> I went down that path a bit but then I (a)
> didn't want the Zope "frame" around the content

It should be possible to suppress this. Let me bug our local wiki 
expert about this. I would like this too, as it would generate much
cleaner iSilo output. (If you use a Palm, you must use iSilo. ;)

> and (b) wanted to
> hand-control the organization.  Wiki organization does not translate
> one-to-one with doc organization, to my taste anyway. 

Maybe the wiki organization needs to change. Maybe you could work 
Anders to improve the organization.

Note too that you can slurp just a section of the wiki by using
offsprint of the appropriate page.

> And wget had trouble
> correctly translating the links to files without extensions...  I assume
> Acrobat would have at least some of the same spidering complications.

Acrobat shouldn't care about extensions and using offspring.

> Unfortunately, hand-control means that I'm creating a one-time wiki
> translation, not something that can automatically maintain itself as the
> wiki changes. So be it. 

I think that this is a pretty fatal flaw. :/

Jim

--
Jim Fulton           mailto:jim@zope.com       Python Powered!        
CTO                  (888) 344-4332            http://www.python.org  
Zope Corporation     http://www.zope.com       http://www.zope.org