h1. FAQ for OpenSolaris Information Resources Wiki
This FAQ provides information about how to use the OpenSlaris Information Resources wiki.
{toc:minLevel=2|maxLevel=2}
h2. How to Print to PDF
You can export a wiki page to PDF format.
# Log in to wikis.sun.com.
You must log in to use this feature.
# Choose Export to PDF from the Tools menu.
# Choose to display or save the file.
h2. How to Add New Content
In wikis.sun.com language, to add new content, you add a page. To add a page, follow these [instructions|How to Contribute].
h2. How Confluence Keeps Track of Pages
All pages within one space have the same URL prefix, whether a child page or parent page. For example, if you create {{yourspace:page1}}, the URL becomes
{noformat}
http://wikis.sun.com/display/yourspace/page1
{noformat}
If you create a {{page2}} as a second page that is a child (nested page) of page1, the URL becomes
{noformat}
http://wikis.sun.com/display/yourspace/page2
{noformat}
*Why Does Confluence Use This Structure?*
This structure is used by Confluence for a couple of reasons:
* The URL is "flat," enabling you to change the nesting without breaking URLs.
* Breadcrumbs, children macros, and other macros use the parent-child relationships and show the pages as a tree hierarchy, for example:
{noformat}
breadcrumb for yourspace:page1 will be Wikis Home > yourspace > page1
breadcrumb for yourspace:page2 will be Wikis Home > yourspace > page2
{noformat}
By using this hierarchy, you can organize your content into trees that are very easy for users to navigate.
h2. How to Title Your Page
Consistently naming pages helps users locate information. In some cases, the wiki moderators will have already created pages for content that has to be provided.
h2. How to Use Labels
Confluence enables you to label, or tag, pages with keywords, which helps in categorizing information. (MediaWiki uses the term "category." Other wikis have similar functionality.) You can add labels to pages at any time by using the Add Labels or the Labels Edit link. Look at the list of labels before adding a new label to see if existing labels fit your needs. This wiki uses specific labels and combinations of labels to generate certain pages, so do not remove or change labels from pages.
Note: You can perform complex label searches in Confluence. Though these searches are not intuitive, you could type the following in the Search box:
{noformat}
label:( +global?solaris) AND label:( +global?security )
{noformat}
This search returns a list of all the pages tagged with both the "solaris" and "security" labels.
Confluence provides a way to view all labels on the wiki. Here are all the labels used by the OpenSolaris 2009.06 Information Resources wiki:
http://wikis.sun.com/labels/listlabels-heatmap.action?key=OpenSolaris200906Info
After clicking this link, you see a page that lists all of the labels used on this wiki. The text of the labels is shown in varying sizes. The larger the text for a specific label, the more frequently that label is used on the wiki." From this page, you can click a label to view all pages tagged with that label.
h2. How to Monitor Wiki Changes
Two ways exist to monitor changes to the wiki and have the wiki send you email notifying you of those changes. You need to log in to perform the following two procedures.
* To monitor the entire wiki space:
# Click Space.
# Click Advanced.
# Click Start watching this space.
* To make sure that you receive notifications of pages that you change, do the following:
** Edit your profile.
** Select Email Preferences.
** Click the Notify on my actions checkbox.
h2. How to Add Jump Lists
Jump lists are mini-TOCs that you can insert into a wiki page. Use the following macros to generate top-level and section-level jump lists. You have to use the {{toc-zone}} macro for section-level macros:
{noformat}
h1. Title
This document summarizes the following:
{toc:minLevel=2|maxLevel=2} <-- This gathers all your h2s at the top.
h2. Topic 1
This section discusses the following:
{toc-zone:minLevel=3|maxLevel=3|location=top|type=list}
h3. Subtopic 1-1
h3. Subtopic 1-2
{toc-zone} <-- The pair of toc-zones defines the section you want the macro to work on.
h2. Topic 2
This section discusses the following:
{toc-zone:minLevel=3|maxLevel=3|location=top|type=list}
h3. Subtopic 2-1
h3. Subtopic 2-2
{toc-zone} <-- A new pair of toc-zones defines a new target section for the macro.
{noformat}
h2. How to Add an Attachment
A centralized page contains all the attachments on this wiki space. Use the following page to upload an attachment to the OpenSolaris Information Resources wiki.
[OpenSolaris Information Resources Attachments]
To reference an image from the OpenSolaris Information Resources Attachments page, use this syntax:
{noformat}
!OpenSolarisInfo:OpenSolaris Information Resources Attachments^image.gif|alt="alt text"!
{noformat}
Be sure to add alt text for the wiki for Section 508.
h2. How to Remove an Attachment
To delete an attachment, you require Remove Attachments permission, which is assigned by a space administrator from the Space Administration screens. See Space permissions or contact a space administrator for more information.
To delete an attachment:
# Go to the [OpenSolaris Information Resources Attachments] page.
# Click the Tools drop-down menu and select Attachments.
This selection displays a list of the attachments in the page.
# Click the Remove link beside the attachment you want to delete.
# Click OK to confirm your action.
h2. How to Subscribe to RSS Feeds
Note: You need an RSS-enabled browser to subscribe to RSS feeds.
# Make sure that you are in the OpenSolaris Info Resources wiki.
# Click Browse Space.
# Click the Advanced tab.
# Click RSS Feeds under the Subscribe heading.
# Choose the RSS feeds you want to subscribe to, for example, Pages.
The Subscribe window appears.
# Choose how you want to subscribe to the feed or feeds, and click Subscribe Now.
# Choose the folder in which you want to receive the RSS feeds.
h2. Choosing a Browser
It appears that wikis.sun.com supports all of the usual browser choices. However, users have reported some problems with Mozilla when _editing_ content, not when viewing it. Recommendation: Use Firefox when editing content.
This FAQ provides information about how to use the OpenSlaris Information Resources wiki.
{toc:minLevel=2|maxLevel=2}
h2. How to Print to PDF
You can export a wiki page to PDF format.
# Log in to wikis.sun.com.
You must log in to use this feature.
# Choose Export to PDF from the Tools menu.
# Choose to display or save the file.
h2. How to Add New Content
In wikis.sun.com language, to add new content, you add a page. To add a page, follow these [instructions|How to Contribute].
h2. How Confluence Keeps Track of Pages
All pages within one space have the same URL prefix, whether a child page or parent page. For example, if you create {{yourspace:page1}}, the URL becomes
{noformat}
http://wikis.sun.com/display/yourspace/page1
{noformat}
If you create a {{page2}} as a second page that is a child (nested page) of page1, the URL becomes
{noformat}
http://wikis.sun.com/display/yourspace/page2
{noformat}
*Why Does Confluence Use This Structure?*
This structure is used by Confluence for a couple of reasons:
* The URL is "flat," enabling you to change the nesting without breaking URLs.
* Breadcrumbs, children macros, and other macros use the parent-child relationships and show the pages as a tree hierarchy, for example:
{noformat}
breadcrumb for yourspace:page1 will be Wikis Home > yourspace > page1
breadcrumb for yourspace:page2 will be Wikis Home > yourspace > page2
{noformat}
By using this hierarchy, you can organize your content into trees that are very easy for users to navigate.
h2. How to Title Your Page
Consistently naming pages helps users locate information. In some cases, the wiki moderators will have already created pages for content that has to be provided.
h2. How to Use Labels
Confluence enables you to label, or tag, pages with keywords, which helps in categorizing information. (MediaWiki uses the term "category." Other wikis have similar functionality.) You can add labels to pages at any time by using the Add Labels or the Labels Edit link. Look at the list of labels before adding a new label to see if existing labels fit your needs. This wiki uses specific labels and combinations of labels to generate certain pages, so do not remove or change labels from pages.
Note: You can perform complex label searches in Confluence. Though these searches are not intuitive, you could type the following in the Search box:
{noformat}
label:( +global?solaris) AND label:( +global?security )
{noformat}
This search returns a list of all the pages tagged with both the "solaris" and "security" labels.
Confluence provides a way to view all labels on the wiki. Here are all the labels used by the OpenSolaris 2009.06 Information Resources wiki:
http://wikis.sun.com/labels/listlabels-heatmap.action?key=OpenSolaris200906Info
After clicking this link, you see a page that lists all of the labels used on this wiki. The text of the labels is shown in varying sizes. The larger the text for a specific label, the more frequently that label is used on the wiki." From this page, you can click a label to view all pages tagged with that label.
h2. How to Monitor Wiki Changes
Two ways exist to monitor changes to the wiki and have the wiki send you email notifying you of those changes. You need to log in to perform the following two procedures.
* To monitor the entire wiki space:
# Click Space.
# Click Advanced.
# Click Start watching this space.
* To make sure that you receive notifications of pages that you change, do the following:
** Edit your profile.
** Select Email Preferences.
** Click the Notify on my actions checkbox.
h2. How to Add Jump Lists
Jump lists are mini-TOCs that you can insert into a wiki page. Use the following macros to generate top-level and section-level jump lists. You have to use the {{toc-zone}} macro for section-level macros:
{noformat}
h1. Title
This document summarizes the following:
{toc:minLevel=2|maxLevel=2} <-- This gathers all your h2s at the top.
h2. Topic 1
This section discusses the following:
{toc-zone:minLevel=3|maxLevel=3|location=top|type=list}
h3. Subtopic 1-1
h3. Subtopic 1-2
{toc-zone} <-- The pair of toc-zones defines the section you want the macro to work on.
h2. Topic 2
This section discusses the following:
{toc-zone:minLevel=3|maxLevel=3|location=top|type=list}
h3. Subtopic 2-1
h3. Subtopic 2-2
{toc-zone} <-- A new pair of toc-zones defines a new target section for the macro.
{noformat}
h2. How to Add an Attachment
A centralized page contains all the attachments on this wiki space. Use the following page to upload an attachment to the OpenSolaris Information Resources wiki.
[OpenSolaris Information Resources Attachments]
To reference an image from the OpenSolaris Information Resources Attachments page, use this syntax:
{noformat}
!OpenSolarisInfo:OpenSolaris Information Resources Attachments^image.gif|alt="alt text"!
{noformat}
Be sure to add alt text for the wiki for Section 508.
h2. How to Remove an Attachment
To delete an attachment, you require Remove Attachments permission, which is assigned by a space administrator from the Space Administration screens. See Space permissions or contact a space administrator for more information.
To delete an attachment:
# Go to the [OpenSolaris Information Resources Attachments] page.
# Click the Tools drop-down menu and select Attachments.
This selection displays a list of the attachments in the page.
# Click the Remove link beside the attachment you want to delete.
# Click OK to confirm your action.
h2. How to Subscribe to RSS Feeds
Note: You need an RSS-enabled browser to subscribe to RSS feeds.
# Make sure that you are in the OpenSolaris Info Resources wiki.
# Click Browse Space.
# Click the Advanced tab.
# Click RSS Feeds under the Subscribe heading.
# Choose the RSS feeds you want to subscribe to, for example, Pages.
The Subscribe window appears.
# Choose how you want to subscribe to the feed or feeds, and click Subscribe Now.
# Choose the folder in which you want to receive the RSS feeds.
h2. Choosing a Browser
It appears that wikis.sun.com supports all of the usual browser choices. However, users have reported some problems with Mozilla when _editing_ content, not when viewing it. Recommendation: Use Firefox when editing content.