RAC Attack - Oracle Cluster Database at Home/Manual of Style

In order to get a consistent look-and-feel throughout the RAC Attack Wikibook, I ask that when you make changes, you try to conform to this manual of style.

This manual of style is not intended to override or replace the Wikibooks manual of style. It is a local manual of style specific to the RAC Attack wikibook. It provides style guidelines valid only within this book.

GeneralEdit

Don't fret about style.
If you have content to add, just add it. Others will edit your contributions so that it fits with the rest of the book's overall style.
Or, if you want to help but have no content to add, help out by trying to bring what's there up to the same standard as the rest of the book.
Use discussion pages.
If you want to make big changes, or are unsure about whether something is an error or not, don't be afraid to bring it up on the page's discussion page.
Use maintenance templates where appropriate.
Maintenance templates provide a handy way to mark up problems in the book.
Don't overdo it, of course.
Prefer to fix the problem, rather than marking it up.
Be bold.
If you see obvious errors, please fix them. Minor changes, especially fixes, don't need discussion.

ConventionsEdit

New Structure
The original book was using a flat structure - that is, there was only one level of sub-pages. (RAC_Attack_-_Oracle_Cluster_Database_at_Home/Your_Page)
Now, the introduction of a new version of the book introduced a new level: (RAC_Attack_-_Oracle_Cluster_Database_at_Home/Rac_Attack_12c/).
The development of the new book is in progress, so expect some changes to the main pages: they will soon point to the new version.
The old version of the book will be soon moved to another new level (./RAC_Attack_11g)


Title Capitalization
This book uses title case. For all chapter and section titles, capitalize the first letter of every word except for articles, prepositions, and conjunctions. (This follows conventions from the Chicago Manual of Style, according to Writer's Block and Wikipedia.)
Templates
This book will have a few standard templates...
  • at top, use the custom navbox for each chapter similar to the box here: Help:Categories It should list each page in that chapter with the current page in bold, and non-linked. Might be able to make this page the same as the chapter page itself... that would be cool and wizard-ly. Will have to learn some more wiki-syntax first.  :)
  • {{chapnav|previous subpage|next subpage}} at bottom of every page, with prev and next linked - this will take care of putting the page in the book category
  • for special, non-book pages (like this one) manually include {{BookCat}}? No - even better, will make a "Special Pages" chapter (excluded from print).
Images
Certain categories should be present for all images.
No Thumbnails
Clipboard

To do:
decide on categories and document here

Print Versions
The only supported way to get print versions of this book will be with a script that generates LaTeX which is converted to PDF and posted publicly. Unfortunately, the layout is very poor with browser-based printing, the built-in wikibooks PDF creator, and the pediapress PDF creator. The main issue is that in-line images are consistently orphaned; and there's no way to set a "keep-with-previous-paragraph" flag for any of the above mentioned options.

New Chapter TemplateEdit

Every chapter page is created in the namespace of the book itself and follows this template:

<noinclude>
{{Sidebox|{{RA/TOC}}|}}

<!-- short overview of the chapter can go here -->
</noinclude>

{{RA/NO-ETOC|''Prev: [[../Download Oracle Enterprise Linux|Hardware and Windows Preparation]]''
----
----
}}

{{RA/Chapter|{{subst:SUBPAGENAME}}}}
#{{RA/A|Create VM}}
#{{RA/A|Prep for OS Installation}}
#{{RA/A|OS Installation}}
#{{RA/A|Wrap-up OS Installation}}
#{{RA/A|Create RAC Attack DVD}}
#{{RA/A|Prep for Oracle}}

{{RA/NO-ETOC|----
----
''Next: [[../Create Interconnect|Create Cluster]]''
}}

New Page TemplateEdit

Follow this example to create new pages:

<noinclude>
{{Sidebox|{{:RAC Attack - Oracle Cluster Database at Home/Linux Install}}|}}
</noinclude>

''Optional intro header paragraph''
----
<br />

<ol><li></li><li>
From the '''SUMMARY''' screen, choose '''Create Virtual Machine'''.  Name the new machine '''collabn1''' and select the '''RAC11g''' datastore.
[[File:RA-vmweb-createVM-name.png|none|border|550px]]

</li><li style="margin-top:3em">
Select '''Linux Operating System''' and choose '''Red Hat Enterprise Linux 5 (32-bit)'''.
[[File:RA-vmweb-createVM-guestOS.png|none|border|550px]]

</li><li style="margin-top:3em">
Choose to '''Create a New Virtual Disk'''.
[[File:RA-vmweb-createVM-disk.png|none|border|550px]]

</li><li style="margin-top:3em">
Set the disk size to '''30G''' and name the file '''collabn1/system.vmdk''' – leave all other options at their defaults and click '''Next'''.
[[File:RA-vmweb-createVM-disk-prop.png|none|border|550px]]

</li><li style="margin-top:3em">
Choose to '''Add a Network Adapter'''.
[[File:RA-vmweb-createVM-net.png|none|border|550px]]

</li><li style="margin-top:3em">
Choose to create a '''NAT''' network connection.
[[File:RA-vmweb-createVM-net-prop.png|none|border|550px]]

</li><li style="margin-top:3em">
Choose '''Don't Add a CD/DVD Drive'''.
[[File:RA-vmweb-createVM-cd.png|none|border|550px]]

</li><li style="margin-top:3em">
Choose '''Don't Add a Floppy Drive'''.
[[File:RA-vmweb-createVM-floppy.png|none|border|550px]]

</li><li style="margin-top:3em">
Choose '''Don't Add a USB Controller'''.
[[File:RA-vmweb-createVM-usb.png|none|border|550px]]

</li><li style="margin-top:3em">
Review the configuration and click Finish.  Do not power on the virtual machine yet.
[[File:RA-vmweb-createVM-summary.png|none|border|550px]]

</li></ol>

{{RA/NAV|Download Oracle Enterprise Linux|Prep for OS Installation}}

Image Upload TemplateEdit

Destination Filename:

RA-[grouping]-[details].png

ScreenshotsEdit

Screenshots are non-free media, so they must be uploaded locally to Wikibooks.

Microsoft-Only and Complete Window (Desktop not Visible)Edit

Do not use this template if it's a partial screenshot or if the desktop is visible (with icons from non-microsoft software)

Non-free media type:

Screenshots of Microsoft Software

Summary:

{{information
|description = <Your Description of the Screenshot> - e.g. Screenshot of "run" dialog, about to launch "msinfo32"
|source = <Complete Product Name> - From ABOUT window; e.g. Microsoft Windows Vista Home Premium
|date = <YYYY-MM-DD> - date screenshot was taken or uploaded
|author = Microsoft Corporation, <Name of Person who Took Screenshot> - e.g. Jeremy Schneider
}}

{{non-free use rationale
|module = RAC Attack - Oracle Cluster Database at Home
|copyrights = Copyright <YYYY> Microsoft Corporation - From ABOUT window; e.g. 2007
|source = <Complete Product Name> - From ABOUT window; e.g. Microsoft Windows Vista Home Premium
|not free = Screenshots of proprietary software are copyrighted. It is impossible to create public domain or free screenshots of proprietary software. These screenshots are being used with permission from Microsoft to illustrate how to use the proprietary software.
|rationale = This book is being written to teach beginners how to use specific proprietary computer software. It is basically impossible to teach this without illustrations - i.e. screenshots. For all practical purposes, this educational book requires the use of screenshots.
}}

[[Category:RAC Attack - Oracle Cluster Database at Home/Files|{{PAGENAME}}]]

All Others - Including Microsoft Partial-Window or DesktopEdit

Non-free media type:

Screenshot includes software interface
  or
Screenshots of web pages

Summary:

{{information
|description = <Your Description of the Screenshot> - e.g. Screenshot of "run" dialog, about to launch "msinfo32"
|source = <URL, Product Name(s)> - URL and/or program name(s) from ABOUT window(s)
|date = <YYYY-MM-DD> - date screenshot was taken or uploaded
|author = <Company Name(s)>, <Name of Person who Took Screenshot> - companies whose software/website appears in this screenshot
}}

{{non-free use rationale
|module = RAC Attack - Oracle Cluster Database at Home
|copyrights = <Company Name(s)> - companies whose software/website appears in this screenshot
|source = <URL, Product Name(s)> - URL and/or program name(s) from ABOUT window(s)
|not free = Screenshots of proprietary software and websites are copyrighted. It is impossible to create public domain or free screenshots of proprietary software or websites. These screenshots are being used under "fair use" to illustrate how to use certain proprietary software.
|rationale = This book is being written to teach beginners how to use specific proprietary computer software. It is basically impossible to teach this without illustrations - i.e. screenshots. For all practical purposes, this educational book requires the use of screenshots.
}}

[[Category:RAC Attack - Oracle Cluster Database at Home/Files|{{PAGENAME}}]]

Diagrams and Other IllustrationsEdit

Try to use only content released under free licenses, these should preferentially be uploaded to Commons.

Last modified on 31 July 2013, at 07:21