RISC OS User Guide PDF

So, without further ado, here is a copy of the User Guide exported as a PDF from Framemaker.

Apart from hopefully having better resolution images, is there any difference between this new export and the version Acorn included on the standard disc image of RISC OS 3.7 computers?

is there any difference between this new export and the version Acorn included on the standard disc image of RISC OS 3.7

Why does that matter? if the answer is ‘no’ it still needs editing for risc os 5, and if the answer is ‘yes’ it still needs editing for risc os 5

Why does that matter?

Out of interest and some editing of the the Acorn released version has already been done.

Wasn’t the Acorn version in HTML? I really think that user guides are best presented in PDF format (in lieu of actual dead trees). HTML is better for random access information (blogs and such).
IMHBLIO, of course.

I agree with Rick, but suspect that Chris E was talking about the text rather than the format.

The PDF we have uploaded was generated from the FrameMaker master document, which was copied straight off a DO (the Acorn Drawing Office) backup CD, there only seemed to be one issue number in there so presumably the latest. As far as we can tell, Acorn didn’t print 3.7 on paper, only as HTML. We may have a 3.6 paper copy lying around somewhere but as has already been pointed out, what matters here is to bring it up to date with RISC OS 5.

Here are our suggested guidelines for image submissions:

The Style Guide used the Morris4 theme as that meant we only had to recapture the 2D screenshots as 3D. The main things about that are:

a) the icons are bold/iconic and when printed greyscale they can still be distinguished with good contrast
b) neutral window furniture that prints well in greyscale; the Ursula theme uses the same furniture as Morris4

The Style Guide and DDE manuals are trying to bridge OS versions 3 to 5 in one generic text. Our view is this is a “RISC OS 5 User Guide”, so the icon set could reasonably be from the Sovereign theme as that’s not Archimedes ‘A’/Acorn ‘nut’/Iyonix ‘jellybean’ branded.

The DDE books are a bit of both already – Ursula window furniture but the chapter headings are Iyonix RISC OS 5 style.

Images are 256 colour PNG (or SunRaster but I doubt anyone can write those now), with no bleed area around them. Where menu trees are open the void space is solid white, not transparent. Turn off the Wimp’s background tiling, flat grey is what you want for printing.

Homerton font.

This is our suggested plan of attack for the User Guide updates:

1. Delete the dead chapters (eg.!PhotoView) & fix up any cross references
2. Note new sections required where dead chapters were relevant (e.g. !CDPlayer is now integrated into CDFSFiler but we just deleted !CDPlayer chapter)
3. Add new chapters for wholly new stuff
4. Rework existing chapters where radically different, e.g. !Configure
5. Integrate relevant text from the Welcome Guide, this covers primitives like using the mouse to control the filer, and is presupposed by the filer chapter (which just says “in the Welcome guide you learned how to…”)
6. Tone down dated references, e.g. “RISC OS 3 PRMs” → “RISC OS PRMs”
7. Edit technical inaccuracies (e.g. the description of how to map out a defect predates large >512MB drives)
8. Review whether the chapter grouping still makes sense (I think not any more) in light of new material
9. Top and tail with new Copyright blocks & trademark boilerplate, etc.
10. Scan the parrot image
11. Check the nesting of the PDF index is sane, sprinkle index markers on new text
12. Review cycles
13. Make the cover artwork & print

Our strong suggestion here is that the community would be most valuable contributing to items 2, 3 and 4 of the above. Please send submissions to userguide@riscosopen.org and we will, from time to time, upload new versions of the PDF as changes are incorporated. Note: don’t expect this to happen quickly!

PS: if anyone wishes to be added to the userguide@ email address, so they too get a copy of emails sent to that address, let me know – via an email to that address…

Looks like a good plan :)

In a way it’s a pity that the book is as big as it is; it’s the sort of thing where I’d love to print it out and start writing all over it but ink isn’t cheap :(

Edit: Although the local stationery shop is offering 30% off ink this week. Hmm…

Points 2, 3 and 4 are one thing when only one person is working on something, but entirely another if more than one person would like to collaborate.

Is there any mileage in creating wiki pages for each chapter (existing or new) on this site, simply as a means of producing collaborative text?

Or is there a better idea?

Is there any mileage in creating wiki pages for each chapter (existing or new) on this site, simply as a means of producing collaborative text?

That sounds like a good idea for developing a plain text version.

Or is there a better idea?

I expect we’ll find out!

Points 2, 3 and 4 are one thing when only one person is working on something, but entirely another if more than one person would like to collaborate.

I think once step 1 is complete and the (missing) chapter headings are known, I’d create a table on a wiki page so that individuals can claim a chapter they’re working on (and it can subsequently be struck through when complete). The Wiki probably supports nested tables, so taking Steve’s 12 point action plan and using that as a basis would seem a good starting point, subdividing it up once more details become apparent.

I can’t see it working where several people are trying to edit the same chapter at the same time. Many of the chapters are < 10 pages long – what’s needed is bums on seats delivering completed text: there’s plenty of half finished or abandoned Wiki pages as it is! Having done some Wiki editing myself I suspect the markup would be a distraction from what’s being asked here: delivering plain text submissions to ROOL for a low maintenance cut & paste editing task.

There will be plenty of opportunity in step 12 for others to pitch in on chapters they didn’t write.

As ever, I reserve the right to be completely wrong.

Here are our suggested guidelines for text submissions:

Please read and adhere to the Tech Pubs Style Guide – for example, the text needs to use the correct tense, with no Americanizations, and you certainly don’t want no double negatives,

I can’t see it working where several people are trying to edit the same chapter at the same time.

We do it all the time where I work, for our technical publications. We use Sharepoint, so someone has to check a document out, and no-one else is able to work on it for the duration of that checkout. So, while no two people can work on something at the same minute, numerous people can work on it over a period of weeks or months.

It’s my experience that you have to have people collaborate; it produces better results. There are so many go-rounds with technical publications. It’s the nature of the beast.

The authors would normally communicate with each other too, via channels outside the document itself.

I’d suggest that the very top of each wiki page list who’s working on it, so that no-one just jumps in without knowing what to expect from other contributors – and when.

And I’d only expect pretty much unformatted text to be developed here – the formatting needs to be added by ROOL (and they don’t want to be removing unwanted formatting first).

what’s needed is bums on seats

I grant you, getting that into the plural is the first challenge.

We have put the work-in-progress PDF (currently identical to the one I linked to earlier) on our Miscellaneous downloads page and there is a wiki page linked to from that download which will act as the focal point for this work. Take a look.

We have put the work-in-progress PDF (currently identical to the one I linked to earlier) on our Miscellaneous downloads page and there is a wiki page linked to from that download which will act as the focal point for this work. Take a look.

Small detail Steve but the Miscellaneous page says that it’s the “3.60 User Guide” and the front page of the PDF says it’s the “RISC OS User Guide for version 3.7”

Obviously that will soon change in the PDF…

the Miscellaneous page says that it’s the “3.60 User Guide”

Corrected now.

Post deleted by moderator.

@Chris (121)

I’d be happy to help out with updating the text for SciCalc and Patience, as I worked on both apps. Bernard: I believe you’ve already produced updated texts for these, so I’d be happy to collaborate in order to get something to ROOL in the right format. I think you’ve got my email – let me know if you’d like to join forces.

Yes, but I don’t know your surname, so I can’t tell if I have your email address! Please just let me know via bernardboase at gmail dot com.

PS. Is it perhaps Wraight? I still don’t find an email address anywhere, though.

Post deleted by moderator.

That’s why I suggested output as PDF/Postscript being a priority, as these sorts of services can print hard copy directly from those.
The world of printing has changed dramatically since Acorn’s day. It is now feasible to do small print runs and print on demand.

I’ll let you know next week how it has turned out

Experiment successful. Nominally identical but 14mm taller.

I don’t mind spending £12.73 on this experiment!

I ended up printing part of the book at home, which ultimately costs around twice what I’d pay Lulu, but what’s done is done. At least I have something that I can draw on now, despite having two page 51s :)