Sun Java Communications Suite Wiki FAQ

This FAQ provides information about how to use the Communications Suite wiki.

How to Print to PDF

You can export a wiki page to PDF format.

1. Sign in to wikis.sun.com.
   You must sign in to use this feature.
2. Choose Export to PDF from the Tools icon.
3. Choose to display or save the file.

Tip Some docs are available as Printable Docs.

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.

You can use also use links to create stubs for new pages, then click the link to open that new page and edit it. For example, suppose that you add the following link:

[Communications Suite 6 Deployment Example]

After you save your edit, the page displays a link titled "Communications Suite 6 Deployment Example" to a page that has yet to be created. Clicking the link displays the Add Page screen, where you create the page.

It is policy to keep all pages in the root, unless they logically belong as chapters of a book, in which case those pages should be children of the book's TOC page.

How to Indicate a Non-Sun Contribution

When contributing a new page as a non-Sun employee, be sure to use the following disclaimer at the top of your page:

{tip:title=Comms Community Contribution}
This article has been received from the Comms Community. It has not yet been verified by Sun.
{tip}

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

http://wikis.sun.com/display/yourspace/page1

If you create a page2 as a second page that is a child (nested page) of page1, the URL becomes

http://wikis.sun.com/display/yourspace/page2

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:

    breadcrumb for yourspace:page1 will be Wikis Home > yourspace > page1
    breadcrumb for yourspace:page2 will be Wikis Home > yourspace > page2
  

  By using this hierarchy, you can organize your content into trees that are very easy for users to navigate.

• Page-level permissions (restrictions) apply to the page and all of its children, so if you set the permissions so that only Sun employees can modify page1, the same rule automatically applies to page2.
• You can move a page and all of its children to a different space or under another page in the same space, making it easy to reorganize even big spaces.
• In the future, you should be able to set a watch on a page and all of its children.

How to Title Your Page

Be sure to work with the Communications Suite wiki administrators to title your page. Consistently naming pages helps users locate information. In some cases, the Communications Suite wiki administrators will have already created pages for content that has to be provided.

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 Labels EDIT link at the top of the page. 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.

See our Philosophy of Wiki Labels for guidelines of label usage.

Note: Apparently, you can perform complex label searches in Confluence. Though these searches are not extremely user friendly at the moment, you could type the following in the Search box:

label:( +global?solaris) AND label:( +global?security ) 

This search returns a list of all the pages tagged with both "solaris" and "security" labels.

Confluence provides a way to view all labels in space. Here are all the labels used by the CommSuite space:

http://wikis.sun.com/labels/listlabels-heatmap.action?key=CommSuite

The bigger the text, the more the label is used. From this page, you can click a label to view all pages tagged with that label.

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:

1. Click Space.
2. Click Advanced.
3. 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.

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:

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.

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 Comms wiki.
Communications Suite Attachments
To reference an image from the Communications Suite Attachments page, use this syntax:

!CommSuite:Communications Suite Attachments^image.gif|alt="alt text"!

Be sure to add alt text for the wiki for Section 508.

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:

1. Go to the Communications Suite Attachments page.
2. Click the Tools drop-down menu and select Attachments.
   This selection displays a list of the attachments in the page.
3. Click the Remove link beside the attachment you want to delete.
4. Click OK to confirm your action.

How to Subscribe to RSS Feeds

Note: You need an RSS-enabled browser to subscribe to RSS feeds.

1. Make sure you are in the CommSuite wiki space.
2. Click Browse Space.
3. Click the Advanced tab.
4. Click RSS Feeds under the Subscribe heading.
5. Choose the RSS feeds you want to subscribe to, for example, Pages.
   The Subscribe window appears.
6. Choose how you want to subscribe to the feed or feeds and click Subscribe Now.
7. Choose the folder in which you want to receive the RSS feeds.

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.