15 replies [Last post]
metusela's picture
Offline
Joined: 08/19/2008
Juice: 3

Hi!

I just felt the need to have the documentation on paper. So I copied everything from the user's guide and made it all into a PDF file.

Now I'd like to share this with you.

PreviewAttachmentSize
bercart User's Guide.pdf271.68 KB
Ryan's picture
Offline
Joined: 08/07/2007
Juice: 15422
Re: User's Guide as PDF

Awesome! I like it... can't believe we've written that much, and yet I wish we had so much more. Sticking out tongue

cgardner's picture
Offline
Joined: 11/21/2008
Juice: 16
Re: User's Guide as PDF

Thank you for this.

drupal-id.com's picture
Offline
Joined: 11/22/2008
Juice: 21
Should be on Docs

This file should be on Docs section, this is really great!

Uberchic's picture
Offline
Administrator
Joined: 08/29/2008
Juice: 754
Excellent!

I completely agree about linking to this in docs! I added some reminder text about the 'printer-friendly version' link at the bottom of all 'book' pages to the end of the initial user's guide page, along with a link to (and credit given to metusela) the pre-formatted awesomeness linked in the initial post.

I know there are people working on extending the drupal core book module ( ie; http://drupal.org/project/e_book ), and I'm interested to see how they improve the actual printing output.

donquixote's picture
Offline
Joined: 09/09/2009
Juice: 35
D6-only version?

I notice that the docs are mostly for D5. It would be cool to have a D6-only version, especially for printout, where you only want the stuff that is relevant for you.

Ryan's picture
Offline
Joined: 08/07/2007
Juice: 15422
donquixote wrote: I notice
donquixote wrote:

I notice that the docs are mostly for D5. It would be cool to have a D6-only version, especially for printout, where you only want the stuff that is relevant for you.

So... I can't figure out if you just didn't read the documentation links or not, but are you aware of... ?

http://www.ubercart.org/docs/user/7437/ubercart_2x

donquixote's picture
Offline
Joined: 09/09/2009
Juice: 35
Re: donquixote wrote: I notice

Sorry, I was too fast again with posting..
From the table of contents, I assume that metusela's pdf (which I am now looking at in paper) is all D5.
So, we just need someone to turn the D6 version into a pdf.. On the other hand, I don't know if the D6 version is completely standalone, or if there is still some "it's the same as in D5, have a look in the D5 docs".

I guess I will find the answers with some research and patience.

Uberchic's picture
Offline
Administrator
Joined: 08/29/2008
Juice: 754
UC 2x on D6 only...

As an interim solution, you could go the ubercart 2x link in the users guide and click the 'printer-frienly version' link at the bottom of that page and it will create a printer friendly verrsion of that page and all the 2x sub pages. http://www.ubercart.org/docs/user/7437/ubercart_2x

The nice thing about this solution is that it will always be up to date with what is currently in the documentation. The down side is that the printout may place page breaks in the middle of lines.

As far as D6 into a pdf, the docs are not finished yet, and some of the documentation issues are part of the hold up on the 2.x release, as noted in ryan's post : http://www.ubercart.org/news/sep-10-2009/ubercart_20_release_plans . But, the docs are ever evolving, and no matter when a pdf is created, unless it is dynamic, it will soon fail to sync with the online docs. Much of the documentation for 2.x is the same as the documentation for 1.x, especially in the users guide. While I have not done a line by line comparison of metusela's pdf to the online docs, i would not be surprised if there are some single line/wording differences, even in the 1.x documentation, now that it's been a year since created.

Ryan's picture
Offline
Joined: 08/07/2007
Juice: 15422
Re: UC 2x on D6 only...

Hmm... I wonder if there's a simple command line PDF generator that we can script to grab a page and generate user documentation periodically... that would be sweet. Smiling

donquixote's picture
Offline
Joined: 09/09/2009
Juice: 35
Re: Re: UC 2x on D6 only...

Can't we control the linebreaks by putting the unbreakable into table rows?
The old and evil and effective layout table!!

stephthegeek's picture
Offline
Theminator
Joined: 10/20/2007
Juice: 575
Ryan wrote: Hmm... I wonder
Ryan wrote:

Hmm... I wonder if there's a simple command line PDF generator that we can script to grab a page and generate user documentation periodically... that would be sweet. Smiling

There's a module for (almost) that Eye-wink http://drupal.org/project/print

We're using this for the new site, where there's an unlinked view that displays the entire documentation section, basically just for the purposes of being able to link to it as a generated PDF.

Gorgeous original Drupal themes (and Ubercart themes!) ~ Psst: more Ubercart themes on our new site

ramyaalluri's picture
Offline
Joined: 06/17/2009
Juice: 2
Really good work Thanku for

Really good work

Thanku for this

sanguis's picture
Offline
Joined: 05/15/2009
Juice: 78
Great

Perhaps the docs should be written in LaTEX so that we can just output a page and a pdf with one command. Also we could keep the documentation in Version Control and allow people to edit the docs.
PS. that makes me think a LaTEX to node with pager mod would be awesome. wish I had time.

Left Click Computers
www.sanguisdevelopment.com over 6 years of custom eCommerce experience
on irc I am sanguisdex

donquixote's picture
Offline
Joined: 09/09/2009
Juice: 35
Re: Great

Would be cool to keep a printable version of the docs up to date automatically. But, I think that doesn't need LaTeX and pdf. What about a view to spit out a long html document?

If it all doesn't help, make it a big table to control header/footer and to prevent undesired page breaks. Or maybe one table per section.

donquixote's picture
Offline
Joined: 09/09/2009
Juice: 35
Re: Re: Great

wow, this is crying for a new module!
- linearize book content and make it print-ready
- you can specify a date of your previous print-out, and the system will find out which pages have changed since then. You print the modified pages, and get some instructions as to where these pages have to be inserted in your existing print-out. (maybe line numbers are all you need)