Skip to content

Latest commit

 

History

History
99 lines (39 loc) · 6.27 KB

Tutorial_guidelines.md

File metadata and controls

99 lines (39 loc) · 6.27 KB
Error in user YAML: (<unknown>): mapping values are not allowed in this context at line 2 column 95
---
 TutorialInfo:
   Class: What is the tutorial about? Modeling? Drafting? Introduction to a workbench?   Level: What level of user is it meant for?   FCVersion: What FreeCAD version are you using?   Time:  How long does it take to complete?   Author:  Add a link to your forum profile
---

Tutorial guidelines

{{Note|Note|This is meant as a test for a new style guideline for tutorials.Feel free to add any ideas or test formatting. DO NOT TRANSLATE!

Inspirations & ideas: Comments from yorik and normandc: *http://manuals.info.apple.com/MANUALS/1000/MA1569/en_US/ipad_2_user_guide.pdf

Introduction

Hello readers, the following document is meant as both a proof of concept and as a test platform to try new ideas; this in order to set a new standard in the creation of tutorials. Hopefully you will find it useful whether as a real guideline or as reference material. And so, without further ado allow me to describe each section of the document. What you are reading right now is meant to be used as a brief summary for your work, perhaps mentioning what workbenches you will use and screenshot of the finished project to use as a thumbnail (hopefully someone will figure how to do it). The box to the right is a new template for tutorials in which concise information can be obtained, such as author, FreeCAD version, and the intended user level. thumb|left|upright=2.5|Thumbnail for the project.

{{Rightbox|Learning| [Part Workbench](Tutorial_Guidelines]]:_Links_and_descriptions_within_the_template_Rightbox_should_be_meant_as_a_tool_to_reference_other_wiki_pages_that_may_aid_in_the_comprehension_of_the_tutorial. Such as a link to the [[Part_Workbench.md).

[[Video tutorials]]: Discover the extensive collections of FreeCAD videos made by community members}}

Welcome!

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Welcome!

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Welcome!

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

{{Rightbox|Learning| Avoid abusing boxes, however. Perhaps one per two sections of the tutorial might be enough. Note that you can include images wihtin the boxes as well.

}}

Welcome!

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Welcome!

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Welcome!

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

{{Note|Note|Remember that it is possible to use boxes to occupy the entire width of the page. This can be useful to highlight something or to create a gallery. Below are two styles to present a gallery.}}

thumb|upright=2.0|Thumbnail for the project. thumb|upright=2.0|Thumbnail for the project.

Image:Astronotus_ocellatus.jpg|Astronotus ocellatus (Oscar) Image:Salmonlarvakils.jpg|Salmo salar (Salmon Larva) Image:Georgia Aquarium - Giant Grouper.jpg|Epinephelus lanceolatus (Giant grouper) Image:Pterois volitans Manado-e.jpg|Pterois volitans (Red Lionfish) Image:Macropodus opercularis - front (aka).jpg|Macropodus opercularis (Paradise fish) Image:Canthigaster valentini 1.jpg|Canthigaster valentini (Valentinni's sharpnose puffer) Image:Flughahn.jpg| Dactylopterus volitans (Flying gurnard) Image:Fishmarket 01.jpg|Semicossyphus pulcher (California Sheephead)


documentation index > Tutorial guidelines