411 REFERENCE · Wikibooks
ROSE Compiler Framework/How to write a How-to
Reference material by Wikibooks contributors. This retains its source identity and is not 411 news reporting.
Quick, short, and focused tutorials about how to do common tasks as a ROSE developer.
Please create a new wikibook page for each how-to topic. Each how-to wiki page should NOT contain any level one (=) or level two(==) heading so it can be included at the correct levels in the print version of this wikibook.
Create a new page
optional step: create an account and log in
Goto: http://en.wikibooks.org/wiki/ROSE_Compiler_Framework/How-tos
Click on Edit tab on the right top of the How-tos page
Copy and paste one existing How-to to the end of the page, for example:
==[[ROSE Compiler Framework/How to write a How-to|How to write a How-to]]==
{{:ROSE Compiler Framework/How to write a How-to}}
rename three places of the pasted text with the desired page name, for example
==[[ROSE Compiler Framework/How to do XYZ|How to do XYZ]]==
{{:ROSE Compiler Framework/How to do XYZ}}
click save page
You will see red text trying to link to the not yet existing How to do XYZ page
click any of the red text, it will bring you to an editing window to add content of your new how-to page
you can now add new content and save it.
Again, each how-to wiki page should NOT contain any level one (=) or level two(==) heading so it can be included at the correct levels in the print version of this wikibook.
Insert image to wiki page
To use your own image in wiki page, you have to upload the image to http://commons.wikimedia.org/.
Once you upload the image, it will become public to all wikibooks users. Be sure to declare your copyright if the image is created by yourself.
Following this instruction to insert image and adjust the layout of your page: http://en.wikibooks.org/wiki/Using_Wikibooks/Inserting_Images
Rules of the content
Only level three headings (===) and higher are allowed in a how-to page. This is necessary for the how-to page to be correctly included into the final one-page print version of this wikibook. Sorry about this restriction.
Again, please don't use level one (=) or level two (==) headings in a how-to page!
Keep each how-to short and focused. Readers are expected to only spend 30-minutes or much less to quickly learn how to do something using ROSE.
After you created a new how-to page and saved your contributions. Please go to the print version to make sure it shows up correctly.
Here is the link: http://en.wikibooks.org/wiki/ROSE_Compiler_Framework/Print_version
Having new content show up in the print version will make sure it is really visible and consistent with the rest of the book.
please specify the how-to topic is the current practice or the proposed new ways of doing things. So we can have clear guideline for code review for what is mandatory and what is optional.