Quick Reference Guides (QRG) FreeCAD v.0.19.2

[MSOlsen65]

bejant did a wonderful job on the v.0.18 Quick Reference Guides (QRG). I have a full set of the files in both PDF and ODF. Thanks for all your hard work bejant!

I am currently working on updating the older v.0.18 QRG for the current FC stable version (v.0.19.2). To make the update better fit the needs of Users, Power Users, and Developers, I decided to open this discussion for suggestions and other input.

Some items that I am already addressing:

• Formatting -- The 0.18 QRG used tables as placement formatting. While this is a simple and fast way to layout text, it also commonly introduces a great deal of complexity into a document. The file size becomes significantly larger and PDF rendering can be quite awkward depending upon the reader used. As such, I will be eliminating tables for the general layout. They will still be used to provide data, but not for generalized placement of paragraphs, headers/footers, etc.
• Icons -- The icons used in the 0.18 QRG are exceedingly large compared to what one sees in the actual program. As the program is opensource, I intend to use the actual icons provided in FC v.0.19.2. I shall use use the medium size as these tend to be clear and consistent while not so large as to dramatically eat up page space.
• Commands -- Following bejant's example, all commands will be as they are presented in the GUI. This is a QRG for the GUI. It is meant to allow rapid reference to what the User actually sees. As a result, I will not be including source code. That said, every command will also be a link pointing to the appropriate Wiki page where one can find the greater details such as the source code.

Stages of Updating:

1. Record the current version of each guide and set this aside as a backup --DONE
2. Activate "set version on file closure" for all files -- DONE
3. Remove tables used solely for general layout -- DONE
4. Adjust icons for better sizing (visually and bit wise) -- Working
5. Compare Commands to FC v.0.19.2, striking through deletions
6. Note Command changes in FC V.0.19.2
7. Addt Commands and Toolbars new in FC v.0.19.2
8. Proof Read by several volunteers
9. Verify existing Wiki links
10. Add missing and fix broken Wiki links
11. Add Wiki links for all new Commands
12. Revise according to Proof Reader recommendations
13. Publish FC v.0.19.2 QRG

Currently, there are 14 QRGs, many with multiple pages. So this update is no small task. That said, I do believe that several of the above stages will make any future updates far simpler. The goal is to get this set of QRGs done as a sort of template for the future, incorporating improvements suggested by those using the guides. Once complete, a new version looking forward to the current FC development version (currently v.0.20.x) can begin being made to hopefully be released simultaneously with the next stable version of FC.

[chrisb]

Thanks for working on it. You can publish the QRG for proof readers as soon as step 7 is completed.

[MSOlsen65]

Thanks for working on it. You can publish the QRG for proof readers as soon as step 7 is completed.

Thanks for the support my friend. It means a great deal to me.

Thanks for the suggestion. I will revise the Stage listing to reflect it.

[sgrogan]

Thanks for working on it.

+1, TIA for the contribution

[Kunda1]

Awesome!

[MSOlsen65]

Awesome!

Thanks for working on it.

+1, TIA for the contribution

Wow! Talk about incredible encouragement! I just hope my efforts prove worthy of your faith in me.

[MSOlsen65]

Quick update:

My computer's "system" drive has crashed. I will be down for a week as I must wait until payday to purchase a new drive. It was only ten years old.

The good news is that I have my current system backed up as a snapshot on a remote server. So once I get the new drive installed, I should operational in less than an hour.

This was sent from my old tablet.

[Kunda1]

Sorry to hear! Great planning ahead!

[paullee]

Good to have an updated reference guide !

Great job !

[MSOlsen65]

Great news

A good friend heard about my computer troubles and is buying me a new 250Gb SSD!

With any luck, I will be up and running again by tomorrow.

Now to Mow the yard while I wait for my new part ...