null


Albin O. Kuhn Library & Gallery - Staff Wiki


Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 195 Next »

Note: You can only perform tasks in the Staff Wiki if you have been given the appropriate permission

Confluence User Guide
Confluence Notation Guide (for Wiki Markup editor)

Wiki Basics

Terminology

  • Confluence - Enterprise wiki provided by DoIT. We often use the terms "Confluence" and "Staff Wiki" interchangeably.
  • Space - Confluence organizes content into "Spaces." UMBC has several spaces; our space is the Library Space. The Dashboard lists all of the Spaces available at UMBC. You can also access a personal Space by logging into the Staff Wiki and clicking on your name at the top of the page, or by going to

     https://wiki.umbc.edu/display/~UMBC_USERNAME.
  • Parent Page - A page that has other pages created underneath it. A parent page may be a child of another page.
  • Children - These are pages created underneath the parent page and associated with it. A child of one page may be a parent of other pages.
  • Rich Text Editor - This editor allows you to enter content as you would in a Word document, and apply formatting simply by clicking icons on a toolbar.
  • Wiki Markup Editor - This editor allows you to edit Confluence pages directly in wiki markup language. Some advanced layout editing is only possible in the Wiki Markup Editor.
  • Labels - User-defined tag words that can be assigned to pages and bookmarks to categorize or identify content.

Navigating the Staff Wiki

  • Left Menu - Displays expandable list of site contents.
    • Click on the + symbol to expand the list; Click on the link name to go to the selected page
  • Menu Bar ** Breadcrumbs - see where you are in the wiki hierarchy and navigate to higher-level pages
    • Browse - use the drop-down menu to view wiki contents by type (pages, attachments, labels, etc.)
    • Log in - Log in to view restricted content
  • Page Functions ** Edit - edit the current page
    • Add - add a new page, blog post, or attachment
    • Tools - view page history and attachments
Page Contents

Page Titles

  • Confluence does not accept the following characters in the title of a page:

    : @ / \ | ^ # $ ; ~ [ ] { } < >
  • Page titles must be unique within a space.

Spell Checking

Confluence does not have a built-in spell checker, but you can use a browser-based spell checker.

Create a page

Using Add Page Function

  1. At the top of the page, hover over then click on 'Page'. The new page will open for editing.
  2. Name your page (see 'Page Titles', above)
  3. Add content using either the Rich Text or Wiki Markup Editors (see 'Edit a page', below, for more information).
  4. When you are through, remember to save your page by clicking on 'Save'.

  • in Wiki Markup editor:
    1. Add a link to the page you wish the new link to be a child of by typing the name you wish the new page to have inside square brackets (i.e. [Page Name]).
    2. Save the current page. The new link will appear in red.
  • Clicking on the link will bring you to the editor for the new page.

From a Microsoft Word Document

  1. At the top of the page, hover over - scroll down the list of options and select 'Import Word Document'
  2. Browse your computer to find the Word document
  3. Click 'Next'
  4. You can import the document as a new page (recommended), or replace the current page
  5. Click 'Import'
  • NOTE: Some formatting (especially indented text) may not display properly, so you may have to edit the page to fix various formatting issues.

Insert an image

  • Click on the Insert Image Icon to insert an image.
    1. Browse for an image on your computer, or select an image that has already been attached to the page (see Attachments for more details).
    2. Use 'From the Web' link to insert an image from a website.
    3. Use Wiki Markup to insert images attached to other pages (see examples)

      Examples

      * image attached to current page: !insert_image.png!
      * image attached to a different page: !Home^word.gif!
      * image in a web-accessible location:
        !http://aok.lib.umbc.edu/img/red_new.gif!
      

Edit a page

  1. From the page you wish to edit, click on
  2. In the editor, use the links above the editing pane to switch between 'Rich Text' editing and 'Wiki Markup'.
    NOTE: Switching between 'Rich Text' and 'Wiki Markup' editing may cause problems with page formatting. If you regularly use macros or extensive formatting, you may want to set your default editor to 'Wiki Markup'.
  3. To see what your page looks like before saving it, use the 'Preview' link.
  4. Once you are finished editing the page, click either of the 'Save' buttons.

Change the parent page

  1. Make sure you are in edit mode for the page you wish to move.
  2. Below the editing pane there is line of text that shows the current location of the page:
  3. To change the parent page, click 'Edit'
  4. Type in the title of the page you wish to use as the new parent. As you type you will be presented with a list of options. Select the page you wish to use.
    • You can also select the new parent page by using the links at the left side to Search the wiki, view a list of Recently Viewed pages, or Browse the wiki.
  5. Click 'OK'.

Adding View & Edit Restrictions

You can set restrictions if you only want certain people to be able to view or edit a page.
NOTE: You must be logged in and have editing permission for a page in order to add restrictions.

  1. Navigate to the page you wish to restrict
  2. Hover over - scroll down the list of options and select 'Restrictions'
    • NOTE: If you are editing a page, you can restrict the page by scrolling to the bottom of the page to where it says Restrictions and clicking 'Edit'
  3. Here you can decide who you want to be able to view your page
  4. Select either 'Restrict viewing of this page' or 'Restrict editing of this page'
    • To restrict viewing or editing to an individual user, enter their username (UMBC e-mail prefix) and click 'Restrict'
      • You can also use the 'Person' button to search for individual users
      • Repeat above step to add more users to the list
    • To restrict viewing or editing to a group, use the 'Group' Button to search for the group
      • Enter library* to view a list of all current groups
        • If you can't find the group you want, please contact the Web Services Librarian (currently Janet Hack, jhack@umbc.edu) to create a new group
      • Select the desired group
  5. Click 'Save' to save your restrictions
    • NOTE: If you are in edit mode remember to save the page

Attachments

Attach a file (document, image, PDF, etc.)

  1. Navigate to the page you want the attachment to be associated with. If the attachment is something that will be used throughout the space, consider attaching it to the Home page.
  2. Hover over then click on 'Attachment'
  3. Browse the computer to find the file you wish to attach.
  4. Optional: In the comments section, enter information that describes the attachment. This can something as simple as the title of the document or a brief description of an image.
  5. Click the 'Attach' button.

Updating an attachment

  • Follow the steps above for attaching a document, making sure that the new document has the exact same name as the document you want to update.
    NOTE: document.doc is NOT the same as document.docx
  • The newly attached document will be the most recent version displayed, and all links to the attachment will point to the new version.

Linking to an attached document

  1. Navigate to where you want to place the link.
  2. Click on the Insert/Edit Link icon at the top of the editing window.
    • If the document is attached to the current page, click on the Attachments link in the left-hand column.
    • If the document is not attached to the current page, use the search box to find the document.
  3. Edit the Link Text (if desired), then click on 'Insert'

Printing & Exporting

Printing a page

You can print a page using your browser's print function. The page contents, excluding the left-hand navigation panel, will be printed. To edit pages before printing, you will want to export the page.

Exporting a page

To export individual pages, first navigate to the page you wish to print.

  1. At the top of the page, hover over - scroll down the list of options and select one of the export options
  • Export to PDF
    • Creates a PDF of the page - some formatting may be lost.
    • Good for pages with simple formatting.
  • Export to Word
    • Opens the page in Word for editing. Maintains most of the formatting.
      NOTE: the page will be opened as a web page. Use the View menu in Word to change to Print Layout for easier editing.
    • You can now edit the page to make any formatting changes you desire, adjust page breaks, etc.

Exporting multiple pages at one time

You can export the entire Wiki, or select groups of pages to export at one time. This is useful for training manuals, guidelines & procedures, etc. All selected pages will export to one file.
NOTE: you can only export groups of pages as PDF, HTML, or XML. If you need to edit the pages after exporting, you will need to export individual pages to Word.

  1. In the black menu bar at the top of the page, hover over - scroll down the list of options and select Advanced.
  2. In the left-hand menu, select Export > PDF Export
  3. Unless you want to export the entire wiki, click the 'Deselect All' link at the top of the page
  4. Scroll down the list and select the pages you want to export. Selecting a parent page will also select all children of that page.
  5. Scroll to either the top or bottom of the page and click the 'Export' button.
  6. After all pages have been exported (this may take a few minutes if you are exporting several pages) click on the 'Download here' link.
  7. Save or open the PDF file.
    Note: All selected pages will be exported to one PDF file with a table of contents listing the pages you selected. Wiki pages will NOT be on individual pages within the new PDF file.

Bookmarking Other Web Sites

  • Hover over and click on 'Bookmark'
    1. Enter the page title and URL
    2. Make sure the space says 'Library Staff Wiki'
    3. Optional: include a description of the site
    4. Label your bookmark so it will be automatically listed in other Confluence pages
  • ORDrag the Bookmark in Confluence link to your browser toolbar
    1. Navigate to the website you want to bookmark
    2. Click on the Bookmark in Confluence link in your browser toolbar
    3. follow steps 2-5 above

Macros

See http://confluence.atlassian.com/display/CONF34/Working+with+Macros for more information on using Macros

Rich Text Editor

  • Start typing { to bring up the Macro selection tool
    • If you know the name of the Macro you wish to use, start typing the name
    • If you don't know the name of the Macro, use the Macro Browser to view a list of available Macros

Wiki Markup Editor

  • Enter the macro in curly brackets {MACRO}
  • OR click on to use the Macro Browser

Commonly Used Macros

Anchor tags

  • To make an anchor tag:

    {anchor:ANCHORNAME}
  • To link to an anchored element:

    [LINK TEXT|#ANCHORNAME]

    Example

    Place an anchor at the top of the page: {anchor:top}
    Place a link to the anchor later in the page:  [top of page|#top]
    

    top of page

Creating a drop-down menu

  • This will make a small arrow appear next to the title. When clicked, links and text associated with the title will appear.
  • For each drop-down menu do the following (replace UPPERCASE with your content):

    {expand:TITLE}
    ENTER TEXT THAT WILL BE HIDDEN (can be links to other pages)
    {expand}
    

    Example

    {expand:Drop Down Menu}
    * Link to another page: [Library Wiki|Home]
    * External link [Library Home Page|http://www.umbc.edu/library]
    {expand}
    
     Drop Down Menu

Displaying content by label

  • To display news (blog) posts only(replace UPPERCASE with your content; Separate labels with commas)

    {blog-posts:labels=LABEL_1, LABEL_2}
    

    Example

    {blog-posts:labels=welcome}
    

    Welcome to the Library Wiki

    Welcome to the Library Wiki, where you will find all the forms, documents, news, and other resources needed by library personnel.

  • To display bookmarks only(replace UPPERCASE with your content; Separate labels with commas)

    {bookmarks:labels=LABEL_1, LABEL_2}
    

    Example

    {bookmarks:labels=homepage}
    

  • To display pages and/or blog postsby label (replace UPPERCASE with your content; Separate labels with commas)

    {contentbylabel:labels=LABEL_1, LABEL_2|operator=|AND/OR|showLabels=TRUE/FALSE
    |showSpace=TRUE/FALSE|type=PAGE,NEWS}
    

    Example

    {contentbylabel:labels=homepage,help_guide|operator=or|showLabels=false
    |showSpace=false|type=page}
    

Displaying Notes or other information

  • To display page content in a colored box. Remember to enclose all Macros in curly brackets: {Macro}
noformat
display unformatted content in a white box

info

Display formatted content in a blue box. Use the 'title=TITLE' parameter to display a title; use the 'icon=false' parameter to turn off the info icon.

note

Display formatted content in a yellow box. Use the 'title=TITLE' parameter to display a title; use the 'icon=false' parameter to turn off the note icon.

warning

Display formatted content in a red box. Use the 'title=TITLE' parameter to display a title; use the 'icon=false' parameter to turn off the warning icon.

panel

Display formatted content in a box. You can set parameters to include a title, and change the color of the title bar and the panel. For more information, see http://confluence.atlassian.com/display/CONF34/Panel+Macro for more information.

Displaying code:

  • If you need to display code (HTML, Java, etc.), this will display it within a box.
  • The default code for this tag is Java, if you are displaying a different type of code, you can enter the appropriate type:

    {code:TYPE} (where type can equal: html, sql, xml, actionscript, or javascript)
    ENTER YOUR CODE HERE
    {code}
    

    Example

    HTML Code

    {code:html}
    <h4>Code for a bulleted list</h4>
    <ul>
    <li>Item one</li>
    <li>Item two</li>
    </ul>
    {code}
    
    <h4>Code for a bulleted list</h4>
    <ul>
    <li>Item one</li>
    <li>Item two</li>
    </ul>
    

Editable Task List

  • No labels