Documentation:About cIRcle Editing Guide

From UBC Wiki
Jump to: navigation, search

This page is intended as a quick reference for useful documentation pages to assist with the creation of cIRcle Wiki content. For more general Wiki/Wordpress documentation, see the Library's tutorial page

Before You Start

  • Categorize!

Add the category "Circle" to the bottom of your wiki page using the format: [[Category:categoryname]] (case and space sensitive!). See Help:Categories for more information.

  • Watchlist

Click "Watch this page" at the bottom of each page you create, edit, or want to reference. You can then use the *Watchlist tab at the top of the Wiki page to navigate to quickly to all the pages you are working on. Note: You will receive updates about this page whenever it is edited so you may want to remove a page from your Watchlist if you no longer need it.

"About cIRcle" Pages by Type

Wiki-Embedded Pages

Edit content for these pages through the UBC Wiki. The easiest way to do this if you are looking at a page on the WordPress site (and are logged on as an admin) is to click the "in Wiki Embed List" link at the bottom of the page, and then click the link to the wiki listed under "URL." Note: you must previously also be logged in to edit the wiki, otherwise it will kick you back to the wiki homepage after you login (if you aren't logged in yet, ctrl+click the login button to open it in a new window, then refresh the page once you have logged in). After you've edited the wiki content and refreshed it on the WordPress page, return to the WordPress page and click "Edit" and then "Publish". This will ensure that the WordPress page displays the same last updated date as the Wiki. See below for instruction on editing wiki content.

About cIRcle Links ~ WordPress -- Wiki
Getting Started for Faculty ~ WordPress -- Wiki
Getting Started for Students ~ WordPress -- Wiki
Setting up a New cIRcle Community ~ WordPress -- Wiki
Licensing & Copyright ~ WordPress -- Wiki
User Guides ~ WordPress -- Wiki
FAQ ~ WordPress -- Wiki
Contact Us ~ WordPress -- Wiki

WordPress-Only Pages

These pages are located only in Wordpress and need to be edited there. Most content can easily be edited using the built-in WYSIWYG editor, however, in order to properly preserve menus and anchored links on the Policies pages you may need to copy and paste some of the existing HTML. Forms need to be edited using the "Gravity Forms" plugin from the Wordpress admin dashboard. For details on editing each of these sections, see below.

Getting Started Launch Page
Policies (all pages)
Forms (all pages) 
Note - Forms must be edited from the "Forms" section of the WP dashboard; NOT "Pages."


Wiki editing

You can format your text using the formatting toolbar or wiki markup. Wiki markup can be thought of as a simplified version of html and it consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki. For example, to format a word in italic, you include it in two single quotes like ''this''.

Text Formatting

Description You type You get
character (inline) formatting – applies anywhere
Italic text ''italic'' italic
Bold text '''bold''' bold
Bold and italic '''''bold & italic''''' bold & italic
Ignore wiki markup <nowiki>no ''markup''</nowiki> no ''markup''
section formatting – only at the beginning of the line
Preformatted text
 preformatted text is done with
 a '''space''' at the 
 ''beginning'' of the line

This way of preformatting only applies to section formatting, and character formatting markups are still effective.

preformatted text is done with
a space at the 
beginning of the line

Organizing

Headers & Lines

Description You type You get
section formatting – only at the beginning of the line (with no leading spaces)
Headings of different levels
=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======

Level 1 is normally set aside for the article title. An article with 4 or more headings automatically creates a table of contents.

Level 1
Level 2
Level 3
Level 4
Level 5
Level 6
Horizontal rule ----

Lists

Description You type You get
section formatting – only at the beginning of the line (with no leading spaces)
Bullet list
* one
* two
* three
** three point one
** three point two

Inserting a blank line will end the first list and start another.

  • one
  • two
  • three
    • three point one
    • three point two
Numbered list
# one
# two<br />spanning more lines<br />doesn't break numbering
# three
## three point one
## three point two
  1. one
  2. two
    spanning more lines
    doesn't break numbering
  3. three
    1. three point one
    2. three point two
Definition list
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2
item 1
definition 1
item 2
definition 2-1
definition 2-2
Adopting definition list to indent text
: Single indent
:: Double indent
::::: Multiple indent

This workaround may be controversial from the viewpoint of accessibility.

Single indent
Double indent
Multiple indent
Mixture of different types of list
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this rather looks like the continuation of # four
#: and thus often used instead of <br />
# five
## five sub 1
### five sub 1 sub 1
## five sub 2

;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2

The usage of #: and *: for breaking a line within an item may also be controversial.

  1. one
  2. two
    • two point one
    • two point two
  3. three
    three item one
    three def one
  4. four
    four def one
    this rather looks like the continuation of # four
    often used instead of <br />
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2
item 1
  • definition 1-1
  • definition 1-2
item 2
  1. definition 2-1
  2. definition 2-2

For even more on list, check out Wikipedia's List Help article.

Signatures

You should always sign your comments, though signatures can be inserted anywhere on a wiki page.

Description You type You get
character (inline) formatting – applies anywhere
Signature Three tildes for just a signature, ~~~ Three tildes for just a signature, Cynthia (UBC LSIT)
Signature with Date and Time Four tildes for your signature with date and time, ~~~~ Four tildes for your signature with date and time, Cynthia (UBC LSIT) 22:27, 26 May 2010 (UTC)
Only Date and Time Five tildes for date and time only, ~~~~~ Five tildes for date and time only, 22:27, 26 May 2010 (UTC)
  • Note: Once you save, the signature and date/time are automatically created. The next time someone edits, it no longer show the tildes.

Links

  • Please see Help:Links for detailed information on creating hyperlinks

Paragraphs

MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tags <br />.

HTML Formatting

Some HTML tags are allowed in MediaWiki, for example <code>, <div>, <span> and <font>. These apply anywhere you insert them.

Description You type You get
Underscore <u>underscore</u> underscore
Strikethrough <del>Strikethrough</del> or <s>Strikethrough</s> Strikethrough
Fixed width text <tt>Fixed width text</tt> or <code>source code</code> Fixed width text or source code
Blockquotes

text text text text text text text text text text text text text text text text text text text text text text text text <blockquote> quote quote quote quote quote quote </blockquote> text text text text text text text text text text text text

text text text text text text text text text text text text text text text text text text text text text text text text

quote quote quote quote quote quote

text text text text text text text text text text text text
Typewriter font
Puts text in a <tt>typewriter
font</tt>. The same font is 
generally used for <code>
computer code</code>.
Puts the text in a typewriter

font. The same font is generally used for computer code.

Superscripts and Subscripts
X<sup>2</sup>, H<sub>2</sub>O
X2, H2O
Centered text
<center>Centered text</center>
* Please note the American spelling of "center".
Centered text
Comment <!-- This is a comment -->

Text can only be viewed in the edit window.

Completely preformatted text
<pre>this way, all markups are '''ignored'''</pre>
 this way, all markups are '''ignored'''.
Customized preformatted text

<pre style="CSS text">this way, all markups are '''ignored''' and formatted with a CSS text</pre>

this way, all markups are '''ignored'''
 and formatted with a CSS text

Mathematical formulas

MediaWiki allows you to use LaTeX to insert mathematical formulae by typing in <math>Formula here</math>. Included here are a couple of examples and commonly used functions and expressions.

What you type What it looks like
Superscript <math> a^2 </math>
Subscript <math> a_3 </math>
Grouping <math> a_{x,y} </math>
Combination <math> a_3^2 or {a_3}^2 </math> or
Root <math> ([n] is optional) \sqrt[n]{x} </math>
Fraction <math> \frac{3}{4}=0.75 or (small) \tfrac{1}{3}=0.\bar{3} </math> or (small)
More Complex Example <math> \sum_{n=0}^\infty \frac{x^n}{n!} </math>

See WikiMedia's Help on Displaying a Formula for a full article on using TeX to display formulae. Beginning at Section 3 (Functions, symbols, special characters) is a comprehensive list of all the symbols.

Footnotes

You can add footnotes to sentences using the ref tag -- this is especially good for citing a source.

What it looks like What you type
There are over six billion people in the world.[1] References:
  1. CIA World Factbook, 2006.
There are over six billion people in the world.<ref>CIA World Factbook, 2006.</ref> References: <references/>

See Also: Help:Footnotes and References



There are two main types of links that can be created on the the UBC Wiki:

  1. internal links to other pages in the wiki
  2. external links to other websites

Internal links

To add an internal link, enclose the name of the page you want to link to in double square brackets. When you save the page, you'll see the new link pointing to your page. If the page exists already it is displayed in blue, if it does not, in red. Selflinks to the current page are not transformed in URLs but displayed in bold. (If you really want to link to the current page, use an anchor (see below), or [[#top|current page]] which always links to the top.)

The first letter of the target page is automatically capitalized, unless otherwise set by the admins, and spaces are represented as underscores (typing an underscore in the link will have a similar effect as typing a space, but is not recommended, since the underscore will also be shown in the text).

Description You type You get
Internal link
[[Main Page]]
Main Page
Piped link
[[Main Page|different text]]
different text
Shortened sort-of-piped link
[[Internationalisation]]s
Internationalisations
Redirect
#REDIRECT [[Main Page]]

See also Help:Redirects

Main Page
Internal link to an anchor
[[#See also]]

Section headings and the top of the page are automatically anchored.

#See also
Internal link to an anchor at another page
[[Help:Formatting#See also]]

If two or more anchors have the same name, add a number, example: #See also2

Help:Formatting#See also
Internal link to the current page's talk page
[[{{TALKPAGENAME}}|Discussion]]
Discussion
Internal link to a subpage
[[/example]]

Shortcut for [[Help:Links/example]]. See also Help:Subpages.

/example
Internal link to a subpage without the leading slash
[[/example/]]

Shortcut for [[Help:Links/example|example]].

example
Internal link to a category page
[[:Category:Help]]

See also Help:Categories

Category:Help
Direct link to an image, pdf, or other file type (rather than linking to the file page)
[[media:example.jpg]]

[[media:example.pdf]]

See also Help:Adding Media

media:example.jpg

media:example.pdf

Internal link to the user's user page
[[Special:MyPage]]
Special:MyPage

External links

Description You type You get
External link http://mediawiki.org http://mediawiki.org
External link with different label [http://mediawiki.org MediaWiki] MediaWiki
Numbered external link [http://mediawiki.org] [1]
External links with file icons [http://en.wikipedia.org/wiki/.avi video] [http://en.wikipedia.org/wiki/.ogg sound] [http://en.wikipedia.org/wiki/.pdf document]

Currently supported extensions: ogm, avi, mpeg, mpg (video); ogg, mid, midi, mp3, wav, wma (audio); and pdf (document)

video
sound
document

External link to the same host http://{{SERVERNAME}}/pagename http://wiki.ubc.ca/pagename
External link to other host passing the pagename http://google.com/search?q={{PAGENAMEE}} http://google.com/search?q=About_cIRcle_Editing_Guide
Mailto link [mailto:info@example.org email me] email me
Mailto named with subject line and body [mailto:info@example.org?Subject=URL%20Encoded%20Subject&body=Body%20Text info] info

How to avoid auto-links

By default, when you write a URL as is, it will be transformed to an external link.

To avoid that effect, put the URL between <nowiki> tags as in:

<nowiki>http://mediawiki.org</nowiki>

See Also

Documentation:MediaWiki Basics/Modifying Link BehaviorTemplate:Http://wiki.ubc.ca/Wiki Help: Adding Media

Tips on Images for Wiki-Embedded Wordpress Pages

Make sure your images are NO WIDER than 570 pixels in the main frame and 340 pixels in the sidebar, otherwise they will spill out of the frames.

If necessary, you can resize images using custom CSS in wordpress: for example .img { width:200px; height:auto;} will resize to 200px width and maintain the aspect ratio (See the "About cIRcle" page). This will apply to all images on the page; you will need to target the tags more specifically if you have multiple different sized images.


Editing Styles in Wiki-Embedded pages

The majority of the style and layout seen on these pages in the WordPress site is through the custom CSS box in WordPress. If design/layout changes are desired, edit the code under "Custom CSS" on the wiki page editor. For new pages, it is advisable to copy the custom CSS from the most similar existing page and work from that.

Creating Drafts of New pages

For drafts of new wiki pages, you can add an automatic draft message by typing the word "draft" between curly brackets {{}}.

Wiki issues & Troubleshooting

Copying and Pasting

From Word: Don't do it. Use Libreoffice, and select "export to wiki." This will result in a plain txt document that you can then copy and paste into the wiki. It does a decent job with wiki markup, but be aware that it will likely still need to be edited to get the formatting right.

Pasting is really, really buggy; it will often add extra line breaks, or remove all your line breaks. I found that copying text in, then selecting it all again and pasting on top of it sometimes worked to keep wiki from removing my line breaks. To my knowledge there is no ideal solution to this, but sometimes it gets it right, so refresh and try again if you keep getting the "line breaks removed" error. It may be necessary to manually go through and remove/add line breaks where necessary if nothing else works.

Wikiembed Links

Links do not always behave correctly once pages are embedded in WordPress using WikiEmbed. To solve this:

  1. Open the page you want to link to and copy the URL to your clipboard
  2. Go to the Wordpress page you are linking from and click "in Wikiembed list" at the bottom (you must be logged in as an admin)
  3. click "all"
  4. browse through the list of links (you will need to mouse over them to see the URL) to find the one that is not working
  5. click "Add Target URL" and paste in the correct URL. Note: this can appear to be identical to the one on the left; this is alright.


Wordpress Editing

Basic Editing

Use the WYSIWYG editor for basic text and page edits, it should work just fine. See below for editing forms and Policy Pages.

For wiki embedded pages, content must be edited on the wiki. In wordpress you should see a code that looks like this: [wiki-embed url="http://wiki.ubc.ca/Library:Circle/About_Circle" update="1440" tabs no-contents no-edit ]

the URL is the URL of the wiki page providing the contents
update should be set to 1440 (24 hrs)
specify "tabs" or "no-tabs" (see About cIRcle page for an example of tabs)
specify "contents" or "no-contents" (see FAQ for an example of contents)
pages should be set to "no-edit"

To view updates in Wordpress, you will need to click "refresh wiki content" at the bottom of the page.

Editing Policies Headers & Contents

The policy pages Contents and headers are built in straightforward HTML. These should be added and edited using the HTML view in Wordpress.

To add a header and contents item;

  1. copy an existing contents item and headline along with the accompanying HTML codes - you will want everything between and including the
  2. tag for the contents items, and including and between the h3 tags for headers.
  3. Paste these into the desired/appropriate locations, and then replace the old text with the new section title.
  4. To create a new anchored link, replace the element after the # in href="#____" in the contents <a> tag with a new marker, and then;
  5. replace the name="___" in the header <a> tag with the same marker.

These marker are currently capital letters, but can be anything and certainly don't need to be consecutive. So, for example, if you were to add a new section between section "K" and "L," you might use the marker "K1". Rule of thumb: copy and paste, try not to change too much.


Editing Forms

UBC CMS
Codex
Welcome to the support documentation for the
UBC CMS Service.
Contents

UBC Content Management System

UBC Collab Theme

UBC Collab Theme Overview
Theme Options Index
CLF Options
Layout Options
Frontpage
Navigation
Display Options
SEO
Export
Import
Global Theme Options

Dashboard Overview
Pages and Posts
Adding Users

Menus
Widgets
Plugins
Forms
Shortcodes
RSS Feeds
Going Live

Complete Topic Index
PDF Wiki Book Version


Gravity Forms can be used to create online forms that site visitors can fill out and an email notification will be sent to the author each time a form is submitted. An example of such a form could ask users to fill out information for an upcoming event.

Important Notice

When using Gravity Forms, do not store/collect any sensitive information. Sensitive information includes student numbers, CWL information, and private personal information. Furthermore, please don't use Gravity Forms for mission-critical information; even though we keep database backups, data loss still might occur.

Form Setup

Log in to your site, if you haven't already done so.

Activate Gravity Forms

  1. Select Dashboard -> Plugins and scroll down to Gravity Forms. On the right, there should be a link to activate the plugin for your site (Enabling Plugins).
  2. A new menu item should appear in the menu bar found on the left side called Forms.

Add a New Form

  1. Go to Dashboard -> Forms -> New Form.
  2. Create your form. Check out this video: Using Gravity Forms (video duration 4:23 min).
  3. Save the form.

Optional: Confirmation Notice

  1. Go to Dashboard -> Forms -> Edit Forms and select the form you wish to change
  2. Click on the "Form Settings" selection in the gray header menu
  3. Select the "Confirmation" tab and edit the confirmation text field
    • If you also wish to add any of the information submitted through the form (ex: name):
      1. Select the "Text" radio button on the "Confirmation" tab
      2. Enter the text that you'd like to precede the form item (name example: "Thank you, ")
      3. Select the form item you'd like to have appear in the confirmation message from the "Insert from field" dropdown
        • Your message in the text field should look similar to this: "Thank you, {Name (First):3.3}"
  4. Alternately, you can also link to an internal or external page upon confirmation by selecting the "Page" or "Redirect" radio button respectively

Embed the form onto a page

  1. Either create a new Page or edit an existing Page: Dashboard -> Pages -> New Page or Dashboard -> Pages -> Pages.
  2. Add the form to the page. Use the gray button between the page title and page body. Note: This is shown in the video above.
  3. Save the Page.

Receive emails from the form

  1. Go to Dashboard -> Forms -> Edit Forms.
  2. Mouse over the name of the form you just created. You should be able to see a "Notifications" link appear below your form's name. Click it.
  3. Under the "Notification to Administrator" heading select the "Enable email notification to administrators" checkbox and fill out the form.
  4. Scroll down and save the form.

Test the form

  1. Go to the page that you just created and fill out your form. Check that you received an email with the information you entered.
  2. Check if the form has a new entry. Go to Dashboard -> Forms -> Edit Forms and check the Entries column, or go to Dashboard -> Forms -> Entries and select the form you just created.

Troubleshooting

Solutions to common Gravity Forms problems:

If you didn't get the entry email

Wait a bit, it might take up to half an hour to get the email. Check your spam to make sure it didn't go in there.

Do Gravity Forms support submission preview?

Gravity Forms do not support submission preview. According to this post, the submission preview feature was supposed to be part of the 1.3 release.

Tips

Conditional shortcode with Gravity Forms:

https://gravitywiz.com/gravity-forms-conditional-shortcode/

Sample Usage: Show Content Only if Value Exists

[gravityforms action="conditional" merge_tag="{My Field:1}" condition="isnot" value=""]<br />
My Field Label: {My Field:1}<br />
[/gravityforms]

See Also

Gravity Form FAQ's

Vendor Documentation

To edit existing forms, choose a form to edit from the Forms page from the dashboard.

Forms can be added to pages using the WYSIWYG editor.

Archiving Forms

Gravity Forms in WordPress keeps database backups but data loss still might occur. To prevent data loss, form data should be archived twice a year. The first archive of form data (all time) occurred on July 31, 2013. The next back-up will be from Aug 1, 2013 - Dec 31, 2013 and will take place in early January.

Instructions for archiving form data are as follows:

  1. Login as administrator
  2. Go to: Forms
  3. Click on Import/Export on the left-hand side
  4. Select the form you want to archive
  5. Select all fields to export
  6. Set the date range
  7. Click "Download Export File"
  8. Data should download to Excel.
a. Select the first column (click on first cell, click Ctrl+Shift+Down Arrow"
b. Select the Data Menu
c. Select "Text to Columns" (defaults should be set to "Delimited" and "Commas"
d. Save file to S:\Procedures\Records Management\Workflow Authorization Forms Archive



Advanced Editing

LIST won't really let you do any. Use JIRA to request advanced changes through them.