Page tree
Skip to end of metadata
Go to start of metadata

This page provides hints / tips on common styles and editing tasks within the DSpace Wiki.

Table of Contents

Confluence Wiki Markup Resources

The below examples are just that – examples! There are many more things you can do withing Confluence. For a full list of ideas and approaches see the Confluence documentation:

Basic Wiki Markup Formatting

This section is only valid if you prefer to edit the Wiki using the "Wiki Markup" tab. If you instead tend to use the "Rich Text" tab, most of these basic formatting options are built into the editing toolbar

Format

What you need to type (in Wiki Syntax)

What you will get

Bold / Strong

*strong*

strong

Italics / Emphasis

_emphasis_

emphasis

Inline Citation

??citation??

citation

Deleted / Strikethrough

-deleted-

deleted

Underlined

+underlined+

underlined

Superscript

word ^superscript^

word superscript

Subscript

word ~subscript~

word subscript

Inline Code

{{ inline monospaced code }}

inline monospaced code

Colored Text

{color:red}look ma, red text!{color}

look ma, red text!

Code Sections

{code}sections of formated code{code}

sections of formated code

Block Quote

{quote}here is quoteble
content to be quoted{quote}

here is quoteble
content to be quoted

Formatted Panel
See Panel Macro for more styling tips.

{panel}text in here displays in a panel{panel}

text in here displays in a panel

Info Box
See Info Macro for more styling tips.

{info}This is an informational box{info}

This is an informational box

Note Box
See Note Macro for more styling tips.

{note}This is a note{note}

This is a note

Warning Box
See Warning Macro for more styling tips.

{warning}This is a warning{warning}

This is a warning

Linking to Attached Files
See Linking to Attachments for more info.

[Text-or-Title|^filename.doc]

(A link to the file named 'filename.doc', attached to the current page)

Headings

What you need to type (in Wiki Syntax)

What you will get

h1. Biggest heading

Biggest heading

h2. Bigger heading

Bigger heading

h3. Big heading

Big heading

h4. Normal heading

Normal heading

h5. Small heading

Small heading

h6. Smallest heading

Smallest heading

Lists

What you need to type (in Wiki Syntax)

What you will get

Bulleted List:
* Item 1
** Item 1.1
** Item 1.2
* Item 2

Bulleted List:

  • Item 1
    • Item 1.1
    • Item 1.2
  • Item 2

Numbered List:
# Item 1
## Item 1.1
## Item 1.2
# Item 2

Numbered List:

  1. Item 1
    1. Item 1.1
    2. Item 1.2
  2. Item 2

Numbered & Bulleted List:
# Item 1
#* Item 1.1
#* Item 1.2
# Item 2

Numbered & Bulleted List:

  1. Item 1
    • Item 1.1
    • Item 1.2
  2. Item 2

Tables

See http://confluence.atlassian.com/display/DOC/Working+with+Tables

Icons / Emoticons

Some examples: (tick) (question) (info) (warning)

See: http://confluence.atlassian.com/display/DOC/Confluence+Emoticons

Table of Contents

For the DSpace Wiki, we tend to use two main types of Table of Contents:

  • Outline Table of Contents (numbered). For outline TOC (e.g. DSpaceResources), add the following to the top of the page:
    {toc:outline=true|style=none}
  • Bullet Table of Contents (bullet points). For bulleted TOC (e.g. see top of this wiki page), add the following to the top of the page:
    {toc}

For more information on formatting a Table of Contents, see the Confluence toc Macro instructions

Redirect Pages

"Redirect Pages" are pages whose sole purpose is to redirect the user to a different location in Confluence. For the DSpace Wiki,
we use "Redirect Pages" to retain the location of the "Current Release Notes" at Current Release. So, that Current Release page will always redirect you to the Release Notes for the latest version of DSpace Software.

To create a Redirect page, insert the following as the only content in the page:

{redirect:<page-to-redirect-to>}

If you ever need to edit an existing Redirect page, just add ?redirect=false on the end of the URL. For, example, use the following URL to edit the Current Release Redirect Page: https://wiki.duraspace.org/display/DSPACE/CurrentRelease?redirect=false

For more information on Redirect Pages, see the Confluence redirect Macro Instructions

Creating your own Personal Page(s) in Wiki

In Confluence, you can create your own Personal Space by doing the following:

  • Login to Confluence
  • Use the top right dropdown (displaying your name), and select "Create Personal Space"

This will create your own personal space at the location ~<your-userid>:Home in this wiki. For example, Tim Donohue.

You can link to this new personal space by creating links with the location being:

~<your-userid>:Home

For example, the following would create a link named "Your Name" pointing at your personal space.

[Your Name|~<your-userid>:Home]

Once you have your personal space established, you can also create your own sub-pages of that space, which you can use for your own notes, thoughts, etc. You can even use this personal space as a basic "blog", by creating daily/weekly "News" items (see the Add -> News menu). For an example of this, see Chris Wilper's personal space (Chris is the Fedora Tech Lead).

  • NOTE: If you want anonymous users to be able to view your personal space contents, you'll need to do the following:
    • Visit your personal space
    • Select "Browse -> Space Admin" in the upper right menu
    • Modify your own personal space's "Permissions" to allow for anonymous user to View your space's contents (by default, only logged in users can view your personal space).

Migrating your old personal pages to your new "Space"

You may "migrate" your existing personal pages to your Personal Space by completing the following steps...

  1. under the tree list of pages, consolidate all your personal pages under your prexisting old mediawiki personal page.
  2. Go to you personal page in the DSPACE space, open your old personal page
  3. under tools, select move and in the dialog at the bottom of the page for space, select you personal space in Confluence.
  4. Saving will move the entire tree of personal pages into your personal space.
  5. Further, you may set the default page for your personal space to be your old mediawiki personal page under your personal space admin.
  6. all preexisting links to your name/pages will move accordingly to point at your personal space.