ROSE Compiler Framework/About the Book

FYI: http://wiki.rosecompiler.org redirects here.

Introduction

The goal of this book is to have a community documentation providing extensive and up-to-date instructional information about how to use the open-source ROSE compiler framework, developed at Lawrence Livermore National Laboratory .

While the ROSE project website (http://www.rosecompiler.org) already has a variety of official documentations, having a wikibook for ROSE allows anybody to contribute to gathering instructional information about this software.

Again, please note that this wikibook is not the official documentation of ROSE. It is the community efforts contributed by anyone just like you.

How To Contribute

• Welcomed Contributions:
  • Fix typos and grammar of existing pages for quality, clarity, and readability.
  • Add new pages about ROSE-specific tutorials, how-tos, FAQ, and workflow
  • Start discussions on the Discussion tab of an existing page about new suggestions of how things can be done better
• Unwelcome Contributions:
  • Rewriting existing documentation, link to it instead if necessary

References

• How to write how-to's
  • http://en.wikibooks.org/wiki/ROSE_Compiler_Framework/How_to_write_a_How-to
• Sandbox
  • Experimenting with writing in the wikibook
  • Link http://en.wikibooks.org/wiki/ROSE_Compiler_Framework/Sandbox
• Adding figures
  • Add figures by uploading your file with
  • Left menu -> Toolbox->upload file
• Think before you edit
  • Is my content providing information that other ROSE users will find helpful?
  • Check your content in the print version of this book
  • Link http://en.wikibooks.org/wiki/ROSE_Compiler_Framework/Print_version

Conventions

• Technical names, identifiers, etc. should be enclosed in teletype, <samp></samp>

  The FooBar class can be found in the foobar.cpp file.

• Source code should use a highlighted code block:

<syntaxhighlight lang="<language>">
<Code goes here...>
</syntaxhighlight>

(Enclosing code in a <pre></pre> block is also okay, but the highlighted code block is preferred.)

• Headings:
  • Capitalize all words e.g. "Graph Processing"
• Subheadings:
  • First word capitalized only

Tracking Wiki Changes

Learn how to "Track Changes": http://en.wikibooks.org/wiki/Help:Tracking_changes

Enable Email Notifications for Changes to this book

If you want to be notified of changes to this book, WikiBooks provides email notifications for changes to Wiki pages that you explicitly choose to watch.

To use this feature:

1. Create an account with WikiBooks: http://en.wikibooks.org/w/index.php?title=Special:UserLogin&returnto=Main+Page&type=signup

2. Login to WikiBooks and set your preferences (top right corner of the web page) for both email notifications and your watch list:

• Email notification settings
  • Preferences-> User profile-> E-mail notifications -> E-mail me when a page on my watchlist is changed (check this on)
• Define your watchlist
  • Preferences->Watchlist -> Advanced options -> you can select the options you want, such as "Add pages I edit to my watchlist" and "Add pages I create to my watchlist"
  • you can also individually watch and unwatch any wiki page: by click on the star on the page's tab list (after View history)

Caveat: we don't know if wikibooks supports users to watch one entire book. So far, you have to do this one page after another by editing them at some points.

Wikibook Writing Tips

1. What exactly is "BookCat" for? It is a category tag automatically added by wiki robot scripts.

2. Should "BookCat" be at the end of the document? Any position in the page should be fine. Having it at top may be better so it won't be accidentally deleted when we add new things at the bottom.