- To add a favorite space:
- From your Dashboard, find the space to favorite in the Site Spaces list.
- Click the star to the right of the space name.
- To remove a page from your Favourite Spaces list, click the star to the right of the space name.
- To view updates in only your list of Favourite spaces:
- Click CyVerse Wiki at the top left to return to your Dashboard.
- Click Spaces in the left column, if not already selected:
You also can click the Favourite Spaces tab in the right column. The setting remains until you change it.
- To add a favorite page:
- Click to view the page to favorite (don't open it for Edit).
- Click Tools on the right and then click Favourite.
- To view your favorite pages:
- Click CyVerse Wiki at the top left to return to your Dashboard.
- Click Pages on the left:
- To remove a page from your Favourite Pages list, click the star to the right of the page name.
For content writers and editors
To create or edit a page, you must have permissions from the space administrator. If you're the space admin, you have full rights.
Basically, if Edit isn't displayed at the top right of the page, you don't have edit permissions. If you want them, contact the space administrator.
Setting space permissions and page restrictions
Space permissions and page restrictions on the Confluence wiki are the way in which you control who sees and edits pages in your space. Confluence doesn't make it all that intuitive, so here's a quick overview.
Permissions are set at the space level by the space admin. Restrictions are set at the page level; your ability to define restrictions depends on the permissions the space admin has given you.
Here's the tricky part: If you want someone to be able to edit a page on your space, the space administration has to give the user or group Add permissions on the space level. Add permission also means they can create a page on your space, which can be not the greatest thing, but it's not a common occurrence.
Groups in Confluence, populated from LDAP groups, set the level of permission or restriction. Within the group you can drill down to specific settings for the space as well as for the page:
There are other groups as well, such as sciteam, core-services, eot, and more. To search for a group or user, click the search button, and enter the first 3-4 letters of the group name or user name to find. If you don't find it, enter an asterisk, click Search, and then browse through the list.
Setting space permissions (space admin only)
Setting page restrictions
You can define the rights a user or group has to a page or group of pages in your space. Even if you gave a group permission to edit (by giving the Add space permissions), you can restrict or further define access to a page in the space.
You may want to check with the user or a user in the group for whom you gave edit permissions to make sure the Edit option is now available.
Pages inherit their settings from their parent page. If you have a group of pages that you want to use the same settings on, create the new page as a child of the page with the settings to use.
Creating a new page
We've all been confused by finding a lot of pages with the exact same title. This is not helpful when people are trying to find the content they need.
Note: If you find a lot of pages with the same or similar title, the space name under the title will guide you to the right page:
Write a title that clearly states what it's about.
"The" (or any other article) adds nothing to the meaning of the page and clutters up the title in search results.
Editing a page
If you do use a TOC, be sure to nest your content sections so Heading 1 is first, then the next heading under that section would be Heading 2, so the TOC shows the proper structure.
Editing in the source editor
The default editing mode is WYSIWYG. It works pretty well most of the time but sometimes things get stuck. You can get around it by editing in the source editor:
Editing an existing section in Wiki markup (Markdown)
You can still enter text using the same old markup we used before, but it's immediately converted to the new editor, which strips out the markup code. The bigger problem is you can't dig into the code to correct problems when they arise.
If you just want to edit a small section that's giving you heartburn, here's a workaround:
You can easily add new text in the wiki-markup panels too, and if you'd rather use Markdown, that's an option too. Help Tips are provided to the right of the screen while in Wiki Markup mode along with a link to a full notation guide. Read more about it here.
Moving a page in the space list (admin only)
By default, new pages go at the bottom of the space list on the left. It's fairly easy to move a page in the same space that you administrate. Moving a page to a different space is a different topic altogether and not within the scope of this page.
Adding external links
Adding links to a CyVerse wiki page
When you need to link to a page on our wiki—say, in an Ask question, paper, or in JIRA—you can use the tiny link, available within the wiki page.
Previewing and saving the page
Preview mode lets you can see how a page will look when you save it. It's not a big deal to Save it (which publishes it too) but here's how you can preview it before you do.
Other bells and whistles
There are some useful things you can add to your pages that help you manage the page, highlight content, and more. Here are a few. If you really want to delve in, ask Kathleen or google "Confluence Wiki" and whatever it is you want to do. Sometimes we don't have the right plugin, so you may be out of luck, but there are a lot of things you can use to make your pages more interesting and navigable by your readers.
This page will grow with time, but here's something to get you started.
Reusing content on multiple pages (Inclusions pages)
It's tedious to have to write or edit the same section over and over, and it's easy to then more than likely you'll forget all the places you wrote that same section, so you have to go back and update everything when something changes, or not update them all. The way around it is to use pages you put it on, which means content is out of sync across pages. The solution is using an Inclusions page. Write it once and plug it the macro tag into all of the pages you want it to show up. When changes are required, all you have to do is update it once the Inclusions page in one place and it propagates to all of the pages you've included it in. For example, the following sentence is a separate Inclusions page I created because I use it so much:
The code I used for it is as simple as this after inserting the Include Page macro:
Step 1 (one-time only): Create the _Inclusions library page for your space (one time only)
InclusionsLibrary page per space.
Step 2: Create the Include page.
Content on this page will be displayed exactly as shown when you insert it into other pages.
Step 3: Insert the Include page content where you want it on your wiki page.
Highlighting important content
There are several different ways you can highlight important information on your page.
For all of the following, open the page for edit, click Insert > Other macros, and then select one of the following, then enter the note that will be contained in the note:
Insert > Other macros > Info
This is an Info box. Similar usage to a Note but less colorful.
Insert > Other macros > Note
This is an info box.
Use it for information you want to call attention to that is not critical in nature.
Insert > Other macros > warning
This is a warning.
Use warnings for something that may cause a dire consequence (like data loss)–and put it before the step or section so the user doesn't perform the action then see that doing so was going to cause something bad to happen.
Expanding sections are a good way to include content that may not be necessary but could be useful. Also good for screen shots when the graphic is useful but not necessary, or for examples of code that can be copied but only needed by those who want to copy the code. Use your discretion.
Here's some text that would be useful but isn't really necessary. The user can click to view it, or skip to the next step quickly and easily.
Note that I changed the title of the Expand header.
You also can add a graphic:
This adds a colored panel with a content section. Good for a section you really want to call attention to since you can customize the colors of the font and background color for the title and body.
Adding an anchor and then linking to the anchor in the same or different page
Anchors should be placed above the section you want to show when the user clicks the link, because they open below the anchor.
Removing a Wiki page from view (best alternative for archiving a page)
Although only the space admin can archive a page, restricting the ability to view the page effectively archives the page by removing it from view to most users. An advantage is that it also removes the page from search results while keeping the page's contents available for historical purposes–always a good idea.
This is the way Kathleen does it for viewing; use it or change it as needed.
You also can just create a panel independent of a Show If section to highlight something more important.
Here's an example of a panel that is visible to all staff (I chose Magenta for the title color because I like magenta):
Only Staff can see this section and panel.