User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Documentation in pdf?

Tue Mar 14, 2017 3:41 am

I am preparing to spend a few, maybe more, without internet (starting in about 5 days time), making some changes that are going to require this for the transition.

Is the documentation for the RPi available in a downloadable offline form? I already have the BCM2835 documentation, as well as the ARMARM for the ARMv6,ARMv7,and ARMv8.

I am looking to get the mailbox documentation, config documentation, the WiringPi documentation, and as much of the other documentation related to the Raspberry Pi as possible.

I thank you.
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

ghans
Posts: 7882
Joined: Mon Dec 12, 2011 8:30 pm
Location: Germany

Re: Documentation in pdf?

Tue Mar 14, 2017 6:17 am

You could clone this repo via git :

https://github.com/raspberrypi/documentation

You would also need software to render Markdown to HTML/PDF


ghans
• Don't like the board ? Missing features ? Change to the prosilver theme ! You can find it in your settings.
• Don't like to search the forum BEFORE posting 'cos it's useless ? Try googling : yoursearchtermshere site:raspberrypi.org

User avatar
rpdom
Posts: 17173
Joined: Sun May 06, 2012 5:17 am
Location: Chelmsford, Essex, UK

Re: Documentation in pdf?

Tue Mar 14, 2017 6:17 am

If it's available online, you can convert it to PDF in Raspbian with CUPS by installing the cups-pdf package which gives you a virtual printer that generates a PDF file (usually saved in your ~/PDF directory.

ghans
Posts: 7882
Joined: Mon Dec 12, 2011 8:30 pm
Location: Germany

Re: Documentation in pdf?

Tue Mar 14, 2017 6:26 am

That would be a better solution , seeing it work on things not written in Markdown too.

ghans
• Don't like the board ? Missing features ? Change to the prosilver theme ! You can find it in your settings.
• Don't like to search the forum BEFORE posting 'cos it's useless ? Try googling : yoursearchtermshere site:raspberrypi.org

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 2:16 pm

Thank you both for the sugestions. I am now installing cups-pdf on my Raspbian to print out those pages to PDF.

It would be nice if the RPi foundation would provide that documentation in a format for viewing without internet.
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

jamesh
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 26660
Joined: Sat Jul 30, 2011 7:41 pm

Re: Documentation in pdf?

Tue Mar 14, 2017 2:20 pm

DavidS wrote:Thank you both for the sugestions. I am now installing cups-pdf on my Raspbian to print out those pages to PDF.

It would be nice if the RPi foundation would provide that documentation in a format for viewing without internet.
It's hard enough getting/keeping what we have now up to date and correct!

The suggestion above - git clone the docs repo, is probably the best bet, and use a Markdown equipped editor (like Atom?). And every time you are online you can do a `git pull --rebase` and easily get the latest version.

The docs repo changes every day, multiple times, so a PDF will become out of date very quickly.
Principal Software Engineer at Raspberry Pi (Trading) Ltd.
Contrary to popular belief, humorous signatures are allowed.
I've been saying "Mucho" to my Spanish friend a lot more lately. It means a lot to him.

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 2:23 pm

jamesh wrote:
DavidS wrote:Thank you both for the sugestions. I am now installing cups-pdf on my Raspbian to print out those pages to PDF.

It would be nice if the RPi foundation would provide that documentation in a format for viewing without internet.
It's hard enough getting/keeping what we have now up to date and correct!

The suggestion above - git clone the docs repo, is probably the best bet, and use a Markdown equipped editor (like Atom?). And every time you are online you can do a `git pull --rebase` and easily get the latest version.

The docs repo changes every day, multiple times, so a PDF will become out of date very quickly.
Unless the docs in the repo were done in PDF or PS to start with, then it would be the most up to date, as it would be a PS or PDF file that is updated.
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

ShiftPlusOne
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 6229
Joined: Fri Jul 29, 2011 5:36 pm
Location: The unfashionable end of the western spiral arm of the Galaxy

Re: Documentation in pdf?

Tue Mar 14, 2017 2:25 pm

The same process that converts the markdown to html for raspberrypi.org/documentation could also generate the PDFs, in theory.

jamesh
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 26660
Joined: Sat Jul 30, 2011 7:41 pm

Re: Documentation in pdf?

Tue Mar 14, 2017 2:27 pm

ShiftPlusOne wrote:The same process that converts the markdown to html for raspberrypi.org/documentation could also generate the PDFs, in theory.
True, I wonder if it's worth putting the effort in to do that.
Principal Software Engineer at Raspberry Pi (Trading) Ltd.
Contrary to popular belief, humorous signatures are allowed.
I've been saying "Mucho" to my Spanish friend a lot more lately. It means a lot to him.

User avatar
PeterO
Posts: 5879
Joined: Sun Jul 22, 2012 4:14 pm

Re: Documentation in pdf?

Tue Mar 14, 2017 2:29 pm

jamesh wrote:
ShiftPlusOne wrote:The same process that converts the markdown to html for raspberrypi.org/documentation could also generate the PDFs, in theory.
True, I wonder if it's worth putting the effort in to do that.
Where is the demand ?

PeterO
Discoverer of the PI2 XENON DEATH FLASH!
Interests: C,Python,PIC,Electronics,Ham Radio (G0DZB),1960s British Computers.
"The primary requirement (as we've always seen in your examples) is that the code is readable. " Dougie Lawson

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 2:39 pm

PeterO wrote:
jamesh wrote:
ShiftPlusOne wrote:The same process that converts the markdown to html for raspberrypi.org/documentation could also generate the PDFs, in theory.
True, I wonder if it's worth putting the effort in to do that.
Where is the demand ?

PeterO
I have seen other threads that were posted in the past about wanting PDF's for online documentation for the same kinds of things. It has been a while.

If you think about it, in educational settings it is not always practical to use the internet documentation, often a PDF is more reasonable.
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 2:40 pm

ShiftPlusOne wrote:The same process that converts the markdown to html for raspberrypi.org/documentation could also generate the PDFs, in theory.
How would I do the same in a batch job?
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

User avatar
kusti8
Posts: 3439
Joined: Sat Dec 21, 2013 5:29 pm
Location: USA

Re: Documentation in pdf?

Tue Mar 14, 2017 2:45 pm

DavidS wrote:
ShiftPlusOne wrote:The same process that converts the markdown to html for raspberrypi.org/documentation could also generate the PDFs, in theory.
How would I do the same in a batch job?
There are many tools
https://kevin.deldycke.com/2012/01/how- ... -markdown/
And you can just do a recursive search and make a PDF for each file.
There are 10 types of people: those who understand binary and those who don't.

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 2:48 pm

kusti8 wrote:
DavidS wrote:
ShiftPlusOne wrote:The same process that converts the markdown to html for raspberrypi.org/documentation could also generate the PDFs, in theory.
How would I do the same in a batch job?
There are many tools
https://kevin.deldycke.com/2012/01/how- ... -markdown/
And you can just do a recursive search and make a PDF for each file.
Thankyou for that.
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

User avatar
bensimmo
Posts: 4625
Joined: Sun Dec 28, 2014 3:02 pm
Location: East Yorkshire

Re: Documentation in pdf?

Tue Mar 14, 2017 2:49 pm

The demand, it would be excellent for me and no doubt clubs (like in school) who print it out for the instructions.

Often a full page document is easier to read over and on a mobile phone, easier to store for later.

I wouldn't say it would enjoy the most used feature though.
Put the feelers out at the clubs and schools.

Adafruit has that pdf feature and it is very nice to use.

Of course what it doesn't do is give you the code file or give cut and paste. But that's just like MagPi too.

User avatar
scruss
Posts: 3212
Joined: Sat Jun 09, 2012 12:25 pm
Location: Toronto, ON
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 2:56 pm

pandoc can do markdown → PDF, but it does it via LaTeX. The TeX Live package you'll need to convert that is absolutely huge, so it might not be the best route.

I've recently discovered WeasyPrint for doing HTML → PDF. It does a really good job: way better than any browser, with proper page flow. It's designed to be scriptable.
‘Remember the Golden Rule of Selling: “Do not resort to violence.”’ — McGlashan.
Pronouns: he/him

ShiftPlusOne
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 6229
Joined: Fri Jul 29, 2011 5:36 pm
Location: The unfashionable end of the western spiral arm of the Galaxy

Re: Documentation in pdf?

Tue Mar 14, 2017 3:00 pm

I didn't have much luck with pandoc, since svg isn't supported. I found some filters which can be used to convert the svg files as required, but they didn't work.

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 3:11 pm

On the note of documentation, the config.txt documentation is missing, 404 at https://www.raspberrypi.org/documentati ... fig-txt.md
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 3:13 pm

To where does the cups-pdf save the created pdf?
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

ShiftPlusOne
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 6229
Joined: Fri Jul 29, 2011 5:36 pm
Location: The unfashionable end of the western spiral arm of the Galaxy

Re: Documentation in pdf?

Tue Mar 14, 2017 3:26 pm

DavidS wrote:On the note of documentation, the config.txt documentation is missing, 404 at https://www.raspberrypi.org/documentati ... fig-txt.md
Should've been fixed if your raspberrypi-sys-mods package is up to date.

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 4:02 pm

kusti8 wrote:
DavidS wrote:
ShiftPlusOne wrote:The same process that converts the markdown to html for raspberrypi.org/documentation could also generate the PDFs, in theory.
How would I do the same in a batch job?
There are many tools
https://kevin.deldycke.com/2012/01/how- ... -markdown/
And you can just do a recursive search and make a PDF for each file.
Ouch, 630MB of space for just those tools. And I am in the process of setting up a complete raspbian install that is to be less than 300MB total including X and all the graphical applications.
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 4:03 pm

ShiftPlusOne wrote:
DavidS wrote:On the note of documentation, the config.txt documentation is missing, 404 at https://www.raspberrypi.org/documentati ... fig-txt.md
Should've been fixed if your raspberrypi-sys-mods package is up to date.
What does a Raspbian package have to do with a web site? I just use the bookmark I have had around ever sense that was added to the RPi site (it used to be only on elinux). I used the elinux version for now.
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

ShiftPlusOne
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 6229
Joined: Fri Jul 29, 2011 5:36 pm
Location: The unfashionable end of the western spiral arm of the Galaxy

Re: Documentation in pdf?

Tue Mar 14, 2017 4:10 pm

Ah, I am not responsible for the internet. I thought you were referring to the link to the documentation in the default config.txt itself.

User avatar
DavidS
Posts: 4334
Joined: Thu Dec 15, 2011 6:39 am
Location: USA
Contact: Website

Re: Documentation in pdf?

Tue Mar 14, 2017 4:13 pm

ShiftPlusOne wrote:Ah, I am not responsible for the internet. I thought you were referring to the link to the documentation in the default config.txt itself.
Ah ok. LOL.

I do not use the default at all.
RPi = The best ARM based RISC OS computer around
More than 95% of posts made from RISC OS on RPi 1B/1B+ computers. Most of the rest from RISC OS on RPi 2B/3B/3B+ computers

jamesh
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 26660
Joined: Sat Jul 30, 2011 7:41 pm

Re: Documentation in pdf?

Tue Mar 14, 2017 5:03 pm

DavidS wrote:
ShiftPlusOne wrote:
DavidS wrote:On the note of documentation, the config.txt documentation is missing, 404 at https://www.raspberrypi.org/documentati ... fig-txt.md
Should've been fixed if your raspberrypi-sys-mods package is up to date.
What does a Raspbian package have to do with a web site? I just use the bookmark I have had around ever sense that was added to the RPi site (it used to be only on elinux). I used the elinux version for now.
It's moved to here..

https://www.raspberrypi.org/documentati ... /README.md

For the reason that the page was huge and needing splitting up.
Principal Software Engineer at Raspberry Pi (Trading) Ltd.
Contrary to popular belief, humorous signatures are allowed.
I've been saying "Mucho" to my Spanish friend a lot more lately. It means a lot to him.

Return to “Off topic discussion”