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:20 pm

If anyone knows of a way to convert a github markdown tree to PDF (pandoc, as mentioned above, has a problem with svg files) please let me know!
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.

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 6:07 pm

Question. Why PDF? If the argument is that you want an offline version of the documentation, just download the .tar.gz or .zip of the documentation. If markdown is not good enough, it's easy to convert to html.

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 7:04 pm

jamesh wrote:(pandoc, as mentioned above, has a problem with svg files)
It does? It made a lovely job for me of the epub version of H.H.Bashford's “Augustus Carp, Esq. By Himself Being the Autobiography of a Really Good Man”, and all its illos are SVGs.

Did you want the tree as one big book, or hyperlinked chapters?
‘Remember the Golden Rule of Selling: “Do not resort to violence.”’ — McGlashan.
Pronouns: he/him

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 7:24 pm

DavidS wrote:To where does the cups-pdf save the created pdf?
It should save it in a PDF sub-directory of your home directory. If running as the "pi" user, that will be in /home/pi/PDF/

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

Re: Documentation in pdf?

Wed Mar 15, 2017 1:30 am

ShiftPlusOne wrote:Question. Why PDF? If the argument is that you want an offline version of the documentation, just download the .tar.gz or .zip of the documentation. If markdown is not good enough, it's easy to convert to html.
While I am just grabbing it as markdown (especially after seeing how huge the utilities + there dependencies are to convert to PDF), there are many that would be much more comfortable with 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

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

Re: Documentation in pdf?

Wed Mar 15, 2017 1:32 am

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.
Which editors do well with markdown? I know I can just translate the markdown in my head, though the correct formatting would be nice.
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?

Fri Mar 17, 2017 8:36 pm

Well I have finaly reached the last leg of my Documentation grabbing on the RPi, getting and double checking everything for RISC OS.
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?

Fri Mar 17, 2017 11:18 pm

Atom works great with markdown, but you might find that it's too huge for you.

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

Re: Documentation in pdf?

Sat Mar 18, 2017 12:01 am

ShiftPlusOne wrote:Atom works great with markdown, but you might find that it's too huge for you.
Thank you, it does not apear to be in the repo, and when doing a search for atom armhf I only find error reports from people that fail to get it working on the RPi, so where do I get it?

Where can I find Atom?
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?

Sat Mar 18, 2017 12:06 am


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

Re: Documentation in pdf?

Sat Mar 18, 2017 12:07 am

ShiftPlusOne wrote:https://atom.io
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

User avatar
Gavinmc42
Posts: 4526
Joined: Wed Aug 28, 2013 3:31 am

Re: Documentation in pdf?

Sat Mar 18, 2017 7:44 am

A search for Raspberry on github returned 36,335 results :o
393 results for "baremetal"
37 results for "raspberry baremetal"
125 "freebasic"

Some might be useful.

138,125 for "OS"
13,287 for "operating system"

138,125 might take sometime to go through.
69million youtubes for "OS"
4.1+Million for "operating system"

Who could make an offline backup of the net these days?

Stuck with iOS/Android? very depressed now :(
https://www.youtube.com/watch?v=-N80hzTpglQ
I'm dancing on Rainbows.
Raspberries are not Apples or Oranges

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?

Sat Mar 18, 2017 2:30 pm

scruss wrote:
jamesh wrote:(pandoc, as mentioned above, has a problem with svg files)
It does? It made a lovely job for me of the epub version of H.H.Bashford's “Augustus Carp, Esq. By Himself Being the Autobiography of a Really Good Man”, and all its illos are SVGs.

Did you want the tree as one big book, or hyperlinked chapters?
Defo.doesn't work for me. What did you have to install to get pandoc to work with SVG - it's a known issue with Pandoc/latexpdf
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?

Sat Mar 18, 2017 2:56 pm

Gavinmc42 wrote:A search for Raspberry on github returned 36,335 results :o
393 results for "baremetal"
37 results for "raspberry baremetal"
125 "freebasic"

Some might be useful.

138,125 for "OS"
13,287 for "operating system"

138,125 might take sometime to go through.
69million youtubes for "OS"
4.1+Million for "operating system"

Who could make an offline backup of the net these days?

Stuck with iOS/Android? very depressed now :(
https://www.youtube.com/watch?v=-N80hzTpglQ
I think I got most of the true open source RPi releated stuff from github :) . Also got most of the documentation for the Raspberry Pi.

The VideoCore IV stuff is going to be fun to play with :) .
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?

Sat Mar 18, 2017 4:44 pm

I thank all for the help. Later today I will be seperated from the internet and this will continue for a few months.

I figured I better give my thanks before I forget (or try to quickly do so at the last second).

I believe that I have just about all the documentation I should need, as well as a lot that I probably will not need.

This will give me something to fill some of my free time over the next few months, especially experimenting more with BareMetal, and attempting to write a good VideoCor IV accelerated bare metal graphics library (yes it is a big challenge).

I hope I have some good stuff to share when I return, thank you all again.
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?

Sun Mar 19, 2017 1:30 am

One last thank you, I will be offline as soon as I finish saying good bye on all the forums. So good bye, I will see you again in a few months time if all goes to plan.
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

Return to “Off topic discussion”