Future Melbourne Wiki Help

Getting Started

Welcome, TWikiGuest!

Welcome to Future Melbourne Wiki! This is a "Wiki" site (pronounced wee-kee site), a collaboration environment for the development of Future Melbourne's City plan. Anyone can contribute using any web browser. Future Melbourne Wiki looks like a normal web site... except that it encourages contribution and editing of pages, questions, answers, comments and updates. Wiki systems are fundamentally editable web pages. It aims to provide a transparent way for you to collaborate and publish your ideas with others over the web.

Some things to do

  1. Read - review Melbourne's city plan prior to Council adoption in October 2008.
  2. Edit - help us improve this plan by editing the document and contributing to discussions.
  3. Discuss - connect with others to work together to improve this plan.

Some basics

Editing a page

  • click Edit in the upper right hand corner, or the bottom left hand corner of any page and make your changes.
  • click Save You've now edited the page!

Viewing the history of a page

Click History at the bottom of page and select revisions to compare, or just select a revision (labeled r4 > r3 ... etc to the right of History.

Attaching files

Click Attach at the bottom of page to upload and attach any type of file to that page.

Collaboration

This site is a collaborative environment, however don't worry too much about that fact, just [[PoliciesAndGuidelines#BeBold][be bold] and edit away. If you're not sure about whether you should add or change something, you can post your thoughts on the associated page. You'll see a Discussion tab which links to it in the upper right hand corner of most every page.

Editing

Editing a page, in this wiki is very easy - simply click Edit in the upper right or lower corner of the screen, type your text & click Save at the bottom of the edit window.

When in edit mode, you will see a range of tools buttons across the top of the edit window. These buttons work in the same way as most word processing software: highlight text, then click the button with the desired action (headings, bold, italics etc.).

When editing you will notice an Edit help link above the upper left corner of the edit window. This link is always present when in edit mode and contains a useful overview of the edit functions and how to use them.

Note: To prevent loss of work in the case of your computer or browser crashing, it is recommended that you click Save and Continue often. This will save your work and return you to edit mode.

Edit conflicts

The wiki will tell you if someone else is editing the same topic at the same time. The simplest thing do to is to come back later and add your text. This avoids having to resolve conflicts (see below) and it also gives you the chance to see what they added before you add yours. Their input may affect what you have to say.

If you do want to edit anyway, you can click the "edit anyway" button and go ahead. If you edit a different part of the topic, the two versions should save ok. If you both edit the same part of a topic, both versions will be saved with special markup to show you what happened...

Resolving Edit conflicts
If two versions of the same paragraph were saved "on top of each other" because two people were editing the same thing at the same time, the wiki will display it like this:

This was the text that was saved first.This text was saved last.
In Raw Text mode, you will see the del and ins tags. In the graphical "wysiwyg" editor, you will see the lines represented the same as in normal view mode.

To "resolve" or choose a final version, you basically remove the text you don't want and remove the formatting (strikethrough or underline) on the text you want to keep. In the wysiwyg editor, for example, you could delete all the strikethrough text, then select the underlined text and click the "Remove formatting" button (which looks like an eraser) in the top row of buttons.

Of course, you could do it the other way around if you wanted to keep the strikethrough text and delete the underlined text. Or you could rewrite the text to merge both contributions and remove all the strikethrough and underline formatting.

Discussion Guidelines

See Future Melbourne's Participation Policies & Guidelines.

Creating New Pages

Creating new pages is done in this wiki by using the Create New Topic tool listed under Tools in the left-hand navigational links.

If you are unsure whether or not to create a new page, go ahead and do it anyway. The Future Melbourne team will keep an eye on new pages created, and if there is already an existing page that is relevant to your contributions they may move your content there and let you know where you can find it. While it is easy and causes no harm to create new pages, it is also important to keep the site tidy and organised so that everyone knows where to find the information they are looking for.

  • Note: You may see the word 'topic' here and there (e.g. the Create New Topic link in the left hand tools). For technical reasons, TWiki, the software used to build this site, uses the term 'topic' in place of 'webpage'. But this needn't concern you, just think 'page' anytime you see 'topic', e.g. 'Create New Page'...

Instructions for creating pages

Using the Create New Topic form to create a page

  1. If there is a page that you wish to be the parent of the newly created page (the page to be hierarchically situated above the one you are creating) navigate there.
  2. In Tools in the left-hand navigation links, click Create New Topic, the Create New Topic in FMPlan form loads.
  3. Enter a topic (page) name in the Topic name: field (the name must be a WikiWord - a word with first letters in capitals and no spaces between).
  4. In the Topic parent: field, enter or choose a parent topic (page), or, leave the topic name that is displayed (the name of the page you were just at).
  5. In the Use template: field, select the template you would like to apply to the new page. If you do not want to apply a template, leave set to Default template.
  6. Click Create this topic, the new, empty topic (page) loads into edit mode.
  7. Type text and click Save. Your new page is now created!

Using default linking to create a page

  1. Type a WikiWord anywhere in any page and it will automatically be rendered as a link after saving.
  2. If the WikiWord is not the name of a page already created, a question mark ? will be displayed after the WikiWord.
  3. Clicking the question mark will take you to that newly created page in edit view.
  4. Enter some text and click Save. Your new page is created!

Note: If you have created a WikiWord that you do not wish to be rendered as a link (e.g. '!VicRoads', or '!McDonald'), simply append an exclamation mark ! before the work like this:

!VicRoads

Create New Topic form versus default linking for creating topics

The advantage of using the Create New Topic form (located in the Tools list in the left-hand navigation bar) is that it provides you with the capacity to choose the parent and apply a template. You can change the parent of a topic after it is created using the More topic actions link at the bottom of any page, however retrospectively applying a template is not possible.

Creating discussion pages

If you wish to create a new discussion page, simply:

  1. Navigate to the page that you wish to be the parent (the one that the discussion will be in reference to).
  2. Follow the steps above for creating a page with the Create New Topic tool.
  3. When you get to the step describing the Use template: drop-down list, select DiscussionTemplate=.

Alternatively, when viewing the page that you wish to be the parent of the discussion page:

  1. Click the Discussion tab in the upper right hand corner.
  2. Click Create '[TopicName]Discussion'.
  3. From Use template: select DiscussionTemplate and click Create this topic.

Note: If a page is created using the Create New Topic tool and the DirectionTemplate is applied, an associated discussion page will be automatically created.

Note: Any page name containing 'Discussion' will be recognised by the system as a discussion page (the upper right button will be inoperable). If you do not want this to be the case, use some other word in your page name, for example 'Talk'.

Linking to a page

Once you have created a new page, you may wish to add a link to that page within the body of another. To do this, use the following format:
  • PageName (the name you gave it), or,
  • [[PageName][some other text]] if you want the link to display as text other than the name of the page.
  • Note: If you are unsure as to the name of a page, it is always displayed at the end of the navigational breadcrumbs at the top of the page when you are viewing it.

Creating plan topics / listing topics in collated view

If you wish to create a new page that is to be a part of the plan structure and/or you want to display an existing page in the Print plan section (see link in the left-hand navigation), then you will need to append a special code to the page's name (this is how the system knows to include it in the plan, and where to put it).

If this looks too confusing, and/or would like someone else to do this for you, see Help Contacts below and email them the details of your request.

The following table shows the appended code chunks needed to display pages in the plan, as well as the chunks needed to display a page in a certain position, relative to the rest of the plan content:

Document level Called Actual label
First level Section S1 S2, etc
Second level Goal - first level G1, G2, etc.
Third level Pathway - first level P1, P2 etc.
Fourth level (Meaninful name from page title) GreatPlaceToVisit
This gives a page name - eg:
  • S2G1P1GreatPlaceToVisit

Another way to confirm that you understand the naming convention, is to have a look at the names of the pages included in the Print Plan (page names are also displayed at the end of the breadcrumbs at the top of every page, and as the last unit of text after the last / in the URL window).

Viewing Revisions

Past revisions of every page are archived and the differences between them may be viewed.

At the bottom of every page viewing revision options include:

Colour code for viewing revisions: red = deleted, blue = added, green = a change within existing text / text block.

Note: If revision comparison shows markup indicating changes, but no changes are apparent in the content, the difference is likely due to a change in the TWiki markup or HTML. This is often hidden by the WYSIWYG editor (normal edit view) which provides a rendered view of the markup code. Use debug in More topic actions at the bottom of the page. This view shows HTML & TWiki markup and will expose the difference.

History

There are several layout options for viewing revisions, History shows 'sequential' view.

  1. Click History at the bottom of any page and select a range of revisions to compare.
    • Selecting more than one revision shows the differences between those revisions.
    • Earlier, Later & First buttons show revisions not listed on the page. More view options displays a range of revisions.
    • Sequential link at bottom of page shows all revisions in standard TWiki sequential view - for all you TWiki traditionalists out there.
  2. Click Compare revisions.
    • Differences are shown in a MS Word, 'track changes' type view. You can also see the changes side by side if you change Render style: Interweave to Side by side (which is pretty nice).

Note: There is currently a bug in the system which means that all tables are shown as struck out and replaced (even if they are not edited). Until we fix it, you can circumvent this issue by using the Sequential mode of display described above.

More revision views

By clicking the More topic actions link at the bottom of any topic (page) you can access more revision functions.

View previous page revision (1 ... 13)

  • shows any revision (enter revision number). Select in raw text format to show the TWiki markup code.

Compare revisions #SequentialView #DebugRevisionView

  • Sequential displays the traditional TWiki revision comparison view.
  • Side by side shows newer revision on right.
  • Debug shows HTML & TWiki markup in the revisions as well as text changes.

Restore

  • To restore to a previous revision, first determine which revision number you wish to restore to.
  • Enter the revision number and click Restore. You will then see the target revision in raw edit mode - click save.

Why does the page revision not increase when I edit?

The same revision will be used when you save a page again within a certain time frame (currently set to one hour by default, but this is configurable).

This is to prevent unnecessary revisions when you do several edit cycles in a row (clicking Save and Continue while you're working), which clutters the Recent Changes. However, a new revision is created if another person edits the same page, regardless of the time.

You can force the creation of new revision at any time (for instance if you want to be able to return to a specific version of the page you are working on) by selecting the Force new revision box below the Save button in edit mode before saving.

Password and Account

Passwords

If you wish to change your password (& you currently know your password) you can do this at any time by visiting ChangePassword.

If you have forgotten your password, visit ResetPassword.

Your user page

Every registered user has their own personal page. This page stores your registration information and any profile information you add to it. You can also use this page as your personal note pad (remember that others will see these notes if they view your user page). For adding new page to your user page, see Creating New Topics.

You can visit your user page by clicking your name in the upper left corner of the navigation links. You can also access your user page (or any other registered user's page) by clicking your (or their) name when it appears as a link, like this: TWikiGuest. You can display your name as a link by typing Users.TWikiGuest. (Your name will also display as a link when you copy and paste the signature line at the bottom of the edit window when in edit mode.)

It is recommended that you visit your user page and update it with information that will help others with understanding the context of your contributions such as the organisation you represent and your title. You can also list pages and themes that interest you, enabling others to draw your attention to such points of interest. You might even attach a photo, like I did.

More Help and Training

The following links are for TWiki specific help, that is, help regarding the TWiki software platform that this site is built with, and not with the Future Melbourne project. These help docs are an invaluable resource of information, however keep in mind that there will be differences in what they present, and how this particular installation of TWiki is structured. The most notable difference is that the Future Melbourne wiki employs a WYSIWYG (what-you-see-is-what-you-get) editor, while the standard installation of TWiki does not. The WYSIWYG editor emulates a word processing program, eliminating the need for 'TWiki markup', simple markup code that tells the browser how to render a page. However you can enter Raw edit mode at any time using the links at the bottom of any page and is the edit mode reflected in the following documentation:

Help Contacts

navigate


click flag to translate page  -                       -  other languages see: LanguageLink

Edit | Attach | Print version | History: r35 < r34 < r33 < r32 < r31 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r33 - 18 May 2008 - 12:24:16 - MarcusLeonard
FPlan.WikiHelp moved from FPlan.FutureMelbourneWikiHelp on 23 Feb 2008 - 04:50 by MarcusLeonard