Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source Magazine

1.5. Simple usage scenarios

Given below are four simple examples demonstrating a small amount of the Wiki’s functionality. Further Mark-ups, beyond those shown here are given in the Mark-up Section.

Case 1: Create a new page

Summary: When editing an existing article or if a word or phrase ought to have an article of its own linked in, just put it in double square brackets, [[like this]]. This is the first step to create a new page. By clicking on the new link one will reach a new empty Wiki page. The page title is automatically set to the text used in the double square brackets.

Figure 6: Case 1 in pictures

Method:

  1. Navigate to the text passage where you would like to add a link to a new page and click on the edit button to enter the Wiki editor.

  2. Choose one or a few words and put them into double square brackets. This creates a link to the new page.  After that press the save button or [ALT+s] to preserve the changes.

  3. The automatically generated question mark by the new link indicates that the link refers to an empty page. Open this empty page by clicking on the link and then fill the new page with content.

  4. The page title is the text typed into the double square brackets when making the link. At the bottom of the editing screen you have space to write a short summary about what you have done. This summary will be displayed in the page history and is useful for other editors. Press the save button and the new page (in this example ‘porro quisquam’) will be created. The automatically generated question mark by the ‘porro quisquam’ link on the previous page will disappear.

 

Case 2: Create a Redirect

Summary: Redirects are used to refer to other pages. If a user tries to access a page, containing a redirect, he or she will be automatically redirected to the page stated in the redirect mark-up. One example usage could be the use of abbreviations, i.e. ‘IDM’ actually refers to the page ‘Identity Management’, another would be if a page has been removed altogether, with its original content added to a different page and a final example would be if a page has had its name changed.

Figure 7: Case 2 in pictures

Method:

  1. The first step is to create a new page by creating a new link (double square brackets, as shown in case 1) or by editing an existing page.

  2. In the page to be redirected from, enter the redirect-Mark-up into the first line, pointing to the target page of the redirect. The redirect Mark-up is shown here in the image to the left of this text, with the target page name in the double square brackets. In this example, anyone attempting to see the page with the redirect link in it will actually be redirected to the page ‘porro quisquam’.

  3. After entering the Mark-up, press the save button or [ALT+s] to preserve the changes.

Now anyone using the ‘varius accumsan’ link will be automatically redirected to the article ‘porro quisquam’.

Case 3: Compare Different Page Versions

Summary: The “diff-tool” is a utility that shows the differences between two page versions, allowing a user to compare any previous version to the current one.

Figure 8: Case 3 in pictures

Method:

  1. The first step to compare different page versions is to click on the version icon in the toolbars at the top or at the bottom of the Wiki.

  2. Now you are shown all the different versions of the Wiki page and any additional information (e.g. date, summary, etc.). By clicking on the ‘compare to newest’ link, the differences between the two versions will be shown.

  3. The comparison of the page versions will be done word by word. If you compare an old version to the latest one, the red colored segments refer to items found in the older version, but not in the latest, while the green segments represent differences found in the latest page version that were not in the older one. Black means that no differences were found.

Case 4: Setting up dr_wiki for a user login

This usage scenario describes how to set-up dr_wiki to use a user login. This is useful to restrict the editing of pages to registered users only.

Skills Level needed: Medium (Template, installing and configuring extensions)

Steps to take

Besides dr_wiki, some third-party extensions are needed:

  1. sr_feuser_register

  2. newloginbox

Set-up sr_feuser_register (http://typo3.org/extensions/repository/view/sr_feuser_register/2.5.7/info/)

Well, this is an optional step, if you plan to administrate your users by yourself. However useful if you want your users to register for your Wiki project by themselves. Normally I use the sr_feuser_register (http://typo3.org/extensions/repository/view/sr_feuser_register/2.5.7/info/) extension, which is quite helpful or this task

The following heap of TypoScript is needed to configure the extension. Simply add it to the "Constants" section of your page template.

 plugin.tx_srfeuserregister_pi1.pid = PID of the storage folder containing the user records

 plugin.tx_srfeuserregister_pi1.userGroupAfterConfirmation = 2

 plugin.tx_srfeuserregister_pi1.email = Email address for the administrator

 plugin.tx_srfeuserregister_pi1.salutation = informal

 plugin.tx_srfeuserregister_pi1.autoLoginRedirect_url = PID of the page to redirect after the registration took place

 plugin.tx_srfeuserregister_pi1.formFields = username,password,first_name,last_name,email

 plugin.tx_srfeuserregister_pi1.loginPID = PID of the page where the login plug-in is installed

 plugin.tx_srfeuserregister_pi1.confirmPID = PID of the page containing the confirmation plug-in of

 plugin.tx_srfeuserregister_pi1.editPID = PID of the page containing the edit plug-in

 plugin.tx_srfeuserregister_pi1.registerPID = PID of the page containing the registration form

 plugin.tx_srfeuserregister_pi1.siteName = your Page Name

 plugin.tx_srfeuserregister_pi1.useShortUrls = 0

 plugin.tx_srfeuserregister_pi1.linkToPID = 0

 plugin.tx_srfeuserregister_pi1.enableAdminNotifyConfirmation = 1

 plugin.tx_srfeuserregister_pi1.enableAdminNotifyOnApprove = 1

 plugin.tx_srfeuserregister_pi1.enableAdminNotifyOnRefuse = 1

 plugin.tx_srfeuserregister_pi1.enableAdminNotifyOnUpdate = 1

 plugin.tx_srfeuserregister_pi1.userGroupUponRegistration = 1

The rest of the configuration can be found in the manual of sr_feuser_register (http://typo3.org/documentation/document-library/extension-manuals/sr_feuser_register/2.5.7/view/), which describes the installation process in full detail.

Set-up the newloginbox

This step is necessary:

  1. Create a sysfolder for the user accounts

  2. Create a page for the newloginbox plugin

  3. Set the "General Storage Folder" to the sysfolder containing the user acounts

Set-up dr_wiki

Well that one is easy:

  1. In the FlexForm of the dr_wiki plugin go to the "Redirect Settings" tab

  2. Select "Red: Redirect to login page if not logged-in on edit?"

  3. Set "Red: Page to use if redirecting is active." to the page containing the "newloginbox" plug-in