>

Style Guidelines for Creating DARSWiki Articles

From DARSwiki
Jump to: navigation, search
UsefulInfo.jpg Note: Take care to read the information detailed in these two-columned tables. Tables with the 'i' speech bubble symbol are used to convey additional useful information to the user.
ImportantInfo.jpg Important Take particular care to read the information detailed in these two-columned tables. Tables with the '!' hazard symbol are used to point out important pieces of information to the user.

Preface

ImportantInfo.jpg Important: This document serves as a style guide to creating DARSWiki articles. The text below in the Preface and Introduction sections should be included in the User Guide document you are creating. You can copy this code by logging into DARSWiki and selecting the Edit tab for this page. All other textual content describes the processes to create and convert wiki articles and formatting of text. Example wiki markup code is displayed in dark red text.

This article will be updated on a regular basis. Updates may be required in response to updates to DARS or changes to business processes or errors.

Refer to DARSWiki Conventions for information on icons and other conventions which may apply to this article.

Ensure you are familiar with the Data Protection laws before adding data to records in DARS. Refer to DARSWiki Further Help for further information and relevant links.

Please think twice before printing this article. If a printed copy is necessary, ensure it is printed double-sided and always recycle old versions.

Introduction

This article serves as a reference guide to the <insert text appropriate to user guide-specific functionality> functionality of DARS.

In this article you will learn the various tasks and functions associated with <insert text appropriate to user guide-specific functionality>, as well as any relevant business processes.

You will require the <insert text appropriate to user guide-specific roles> role(s) in order to access and use the functionality described in this user guide. If you are unsure of your role and access rights to the DARS system, please contact the DARS Helpdesk (see DARSWiki Further Help for contact details).

DARSWiki Article Creation

Current versions of MS Word can have an add-in installed for ‘Mediawiki’ which is available from www.microsoft.com/en-us/download/details.aspx?id=12298.

UsefulInfo.jpg Note: If you do not already have the Mediwiki add-in installed, you will need to email the IT Helpdesk at help@it.ox.ac.uk to request install of the add-in onto your PC. The install is specific to your PC rather than being attached to your Oxford SSO (single sign-on) login. You will not therefore be able to use the add-in if you are logged on to another machine unless the add-in has also been installed on that machine.

The Mediawiki add-in enables users to convert a Word document such as a User Guide or Quick Reference Guide (QRG) to a simplified HTML language called Wiki markup. Following conversion, the final result will need some tidying up and amendments, as detailed in the After Converting section. Once the required amendments have been made, this Wiki markup language can then be uploaded onto the DARSWiki to create a new DARSWiki article.

ImportantInfo.jpg Important: The add-in for Mediawiki will not work in a Windows 8 system and there is no similar for that system.

Terminology

  • HTML – Hypertext Markup Language.
  • CSS - Cascading Style Sheets.
  • Wiki markup – simplified markup language for creating wiki pages.

Process Steps Checklist

This process checklist summarises the key steps that you will need to follow if you wish to create a new DARSWiki article(s) for new or existing DARS User Guides and QRG’s.

  1. Create any new User Guides or QRGs in MS Word first – it is much easier to create visually.
  2. Modify the (new or existing) MS Word document before converting.
  3. Remove all in-line icon and button images and replace with icon and button names.
  4. Remove larger images from the document, saving these in appropriate folders on your PC. Resize the images in MS Paint, if applicable. Please see the sections Saving Files and Images and Uploading Images to DARSWiki for further guidance on saving and resizing images.
  5. Convert the MS Word document to a ‘MediaWiki’ file.
  6. After converting, edit the wiki markup in Notepad++ and save as a .txt document.
  7. UsefulInfo.jpg Note: Notepad++ can be installed by navigating to Start > All programs > Oxford Applications Installer. Select Notepad++ to install this application and it will be queued for installation.
  8. Upload the wiki markup language, saved in Notepad++ to a new DARSWiki article.
  9. Upload your saved images to DARSWiki.
  10. Refine your article in the DARSWiki edit screen.
Back to page contents

Create DARSWiki User Guides

You can convert existing Word document user guides to wiki markup, or create new Word documents from scratch and then convert.

Create a New Document

Compose your new user guide, training manual or QRG in Microsoft Word. It is much easier, visually, to create in MS Word and then Save as a Mediawiki document.

  • The document should include minimal formatting using Body 1 and Heading (1, 2 and 3) styles, numbering (1.2.3, a.b.c and i ii iii) and bullet points. These will require some tidying up after conversion. See After Converting.
  • By design there is no (and none should be added) title page, TOC (table of contents - see note below), headers and footers, section or page breaks or Conventions, Data Protection and Further Help and Information sections.
UsefulInfo.jpg Note: Remove the table of contents from your user guide, if your user guide contains one. It is permissible to have a table of contents at the beginning of each DARSWiki article you create. This is generated automatically based on the heading structure which exists in your Word document i.e. 1. Main Heading, 1.1 Sub-Heading, 1.1.1 Minor Sub-Heading. See After Converting for further explanation.
  • All windows, tabs, forms, pages and screen/dialogue box titles should be in Italic text.
  • All menu, field and button/link names/labels should be in bold text.
UsefulInfo.jpg Note: Bold text and italic text will convert from a Word document to wiki markup. Underlined text will not convert. See the section Useful Codes for Editing DARSWiki Articles Post-upload for details on how to render text as underlined, once you have uploaded your article, within the DARSWiki Edit screen.
  • Tables in the Word document should be kept simple. Tables will convert to wiki markup, however, they will require some tidying-up after conversion. See After Converting for further details.
  • Images will not convert. In addition, they take up disk space so should be used sparingly. See point 5 in Tidy Up MS Word Document.
  • The content of the user guides should be split into manageable chunks. See point 4 in Tidy Up MS Word Document.
  • Important and Useful notes are enclosed in a two column table as shown in the examples below. The wiki markup code required to define/create these tables is provided beneath each example. Important and Useful notes are enclosed in a two column table as shown in the examples below. The wiki markup code required to define/create these tables is provided beneath each example. The Important information and Note icon images are already uploaded to the DARSWiki site and named ImportantInfo.jpg and UsefulInfo.jpg respectively.
  1. Copy and paste the relevant table code (important or note table code) from this page into your Word document at the required location.
  2. Copy the note/important note text from your existing note table in Word.
  3. Replace the text on line 4 of the wiki markup table code with that copied from your Word table.
  4. Delete the Word table which contained the important / useful note from your Word document.
  5. The conversion process will assume that any wiki code included in your MS Word document is MS Word text, not wiki code, and will enclose it in the <nowiki></nowiki> tags. See point 8 in the section After Converting for details on how to remove these tags.
UsefulInfo.jpg Note: Use these tables to inform users of additional useful information, hints or tips in your user guide. The tables clearly stand out from the main body of the text and encourage users to read the content. Ensure therefore that you keep these useful notes clear and concise.

{| class="wikitable" style="width: 70%;"

|-

| width="25pt"|[[File:UsefulInfo.jpg]]

| '''Note:''' Use these tables to inform users of additional useful information, hints or tips in your user guide. The tables clearly stand out from the main body of the text and encourage users to read the content. Ensure therefore that you keep these useful notes clear and concise.

|-

|}

ImportantInfo.jpg Important: Use these tables to emphasise particularly important pieces of information for users to be aware of. The tables clearly stand out from the the body of the text and encourage users to read the content. Ensure that you keep these notes clear and concise.

{| class="wikitable" style="width: 70%;"

|-

| width="25pt"|[[File:ImportantInfo.jpg]]

| '''Important:''' Use these tables to emphasise particularly important pieces of information for users to be aware of. The tables clearly stand out from the the body of the text and encourage users to read the content. Ensure that you keep these notes clear and concise.

|-

|}

  • Once your new Word document has been created, follow the instructions in the Before Converting section below.
Back to page contents

Before Converting an Existing Word Document

Existing Word document DARS training manuals and user guides will need some tidying up before they are converted to Wiki markup.

Tidy Up MS Word Document

  1. Remove the title page, table of contents, all headers and footers and all section or page breaks. If you do not remove all such items from your Word .doc and you attempt to save your document as a Mediawiki file, the error message below will be displayed. Check your document and remove any offending headers, footers, page breaks etc.
  2. ”The error message which displays if you have not correctly removed all non-converting items from your Word document.”


  3. Remove the Conventions, Data Protection and Further Help and Information sections – and any sections within those (i.e. you should including content that is specific to your user guide).
  4. UsefulInfo.jpg Note: Two separate DARSWiki articles have been created which include all of the information contained within the user guide ‘Conventions’, ‘Data Protection’ and ‘Further Help and Information’ sections. These are: Conventions and FurtherHelp. By following this style guide, and including the Preface and Introduction sections at the start of your DARSWiki user guide you will note that you will have already provided the DARS User with links to this additional information.
  5. Change the format of all windows, tabs, forms, pages and screen/dialogue box titles to italic text. Scan through the document to ensure that all menu, field and button/link names/labels are in bold text.
  6. UsefulInfo.jpg Note: Bold text and italic text will convert from a Word document to wiki markup. Underlined text will not convert. See the section Useful Codes for Editing DARSWiki Articles Post-upload for details on how to render text as underlined, once you have created your new article, within the DARSWiki Edit screen.
    ImportantInfo.jpg Important: Scan-read the document to ensure that all words that should be in bold or italic are as specified above to ensure consistency across all DARSWiki articles. Do not assume that the formatting in the existing document conforms to these style guidelines.
  7. Content should be in manageable chunks both for editing wiki markup and for user reading. If the user guide which you are converting is a lengthy document, each main section should be saved as a separate word document for each major numbered section (1, 2, 3 etc).
    1. Any level 4 sections (e.g. 4.3.2.1) should be rolled up into level 3 (e.g. 4.3.2) or a new level 3 section created.
    2. Each main section should be a separate DARSWiki article. See the Fundamentals 1 manual as an example.
    3. Include the Preface and Introduction sections together as the first page/article of your user guide. See the Fundamentals 1 manual as an example.
    4. You may choose to subdivide a main section to further separate articles depending on size of that section and the logic/flow of the content. For smaller user guides, it may be more appropriate to create a single wiki article.


  8. Important and Useful notes are enclosed in a two column table as shown in the examples below. The wiki markup code required to define/create these tables is provided beneath each example. The Important information and Note icon images are already uploaded to the DARSWiki site and named ImportantInfo.jpg and UsefulInfo.jpg respectively.
    1. Copy and paste the relevant table code (important or note table code) from this page into your Word document at the required location.
    2. Copy the note/important note text from your existing note table in Word.
    3. Replace the text on line 4 of the wiki markup table code with that copied from your Word table.
    4. Delete the Word table which contained the important / useful note from your Word document.
    5. The conversion process will assume that any wiki code included in your MS Word document is MS Word text, not wiki code, and will enclose it in the <nowiki></nowiki> tags. See point 8 in the section After Converting for details on how to remove these tags.
    UsefulInfo.jpg Note: Use these tables to inform users of additional useful information, hints or tips in your user guide. The tables clearly stand out from the main body of the text and encourage users to read the content. Ensure therefore that you keep these useful notes clear and concise.

    {| class="wikitable" style="width: 70%;"

    |-

    | width="25pt"|[[File:UsefulInfo.jpg]]

    | '''Note:''' Use these tables to inform users of additional useful information, hints or tips in your user guide. The tables clearly stand out from the main body of the text and encourage users to read the content. Ensure therefore that you keep these useful notes clear and concise.

    |-

    |}

    ImportantInfo.jpg Important: Use these tables to emphasise particularly important pieces of information for users to be aware of. The tables clearly stand out from the the body of the text and encourage users to read the content. Ensure that you keep these notes clear and concise.

    {| class="wikitable" style="width: 70%;"

    |-

    | width="25pt"|[[File:ImportantInfo.jpg]]

    | '''Important:''' Use these tables to emphasise particularly important pieces of information for users to be aware of. The tables clearly stand out from the the body of the text and encourage users to read the content. Ensure that you keep these notes clear and concise.

    |-

    |}

  9. No images will convert:
    1. Any in-text images should be deleted, and replaced with text (in bold)
      • Instead of ‘…click the <image of Add icon> icon to add a new address...’
      • The instruction should be amended to ‘…click Add to add a new address...' or '...click the Add icon to add a new address...'
    2. Delete any unnecessary screenshot images and, for those that will be required, crop them to the bare requirements. See the next section Saving Files and Images. You will re-size the images later, as required, in MS Paint.
    3. Screenshots of common error messages should be replaced with the error message text in big, blue, italic type, within a two-column table. An example is provided below with the wiki markup code used to define this message beneath.
      ‘….the following error message will be displayed:
      ImportantInfo.jpg ‘Your server connection may have been temporarily lost. You may need to click the refresh button or log in to the application again.’
      ‘….the following error message will be displayed:

      {| class="wikitable" style="width: 70%;"

      |-

      | width="25pt"|[[File:ImportantInfo.jpg]]

      | <span style="color:blue"><big>''‘Your server connection may have been temporarily lost. You may need to click the refresh button or log in to the application again.’''</big></span>

      |-

      |}

    4. For those screenshots and larger-scale images that you wish to retain in your article, the following process is recommended:
      1. Save and name the first image to your PC according to the system defined in Saving Files and Images, e.g. 11-5-ConstituentSearchScreen.jpg
      2. Remove the image from the document
      3. In place of the image, insert the code [[File:11-5-ConstituentSearchScreen.jpg|border|alt="Screenshot showing the layout of the Constituent Search Screen".]]. NOTE: All images should have both a border and alternative text as included here in this example code.
      4. This will act as a marker for that particular image once the document is uploaded as a DARSWiki article. The marker in your wiki article will appear as red text on your Wiki article, e.g. as:File:11-5-ConstituentSearchScreen.jpg
      5. The final step will be to upload the file from your PC to the location you specified by your marker code – see Uploading Images to DARSWiki for further details.
  10. Tables do convert from Word to Wiki markup, but will need some tidying up. See Tables for further details.
  11. Bullets and numbering do convert, but not always consistently. Some tidying up will be required. See Bullets and Numbering for further details.
  12. Links to external (i.e. URL or email) links should convert. Internal links will not convert and will need to be recreated. See Links for further details.
  13. Before converting, don’t forget to spell-check your document.

Saving Files and Images

Ensure files and images are named and saved consistently so that they can be easily managed.

  1. Image and document folders should be named as shown in the example below for the Revenue and Administration manual, with sub-folders for each main section where all images and documents for that section will be stored:
    RevAdmin
    Documents
    1BGInfo
    2ConstRevRecord
    3Payments
    Images
    1BGInfo
    2ConstRevRecord
    3Payments
    If correctly named, you would be able to find the file of the third image in section 3.2 of the Revenue Administration manual, by following the path RevAdmin > Images > 3Payments > File name ‘32-3-PaymentScrnRA.jpg’.
    • The 'RA' tag at the end of the image name identifies that this is an image in the Revenue Administration manual.
    • Please ensure that you include a 2-3 letter abbreviation of the user guide name as the final part of your image name, as in this example.
  2. When saving .txt documents, file names should have no spaces and limited to letter characters (e.g. FurtherHelp.txt).
  3. Any screenshot images to be included in the wiki article should be saved as .jpg files. This should not be done until you have completed the final draft and the document is ready to be converted. Images should be:
    1. No larger than 600 px wide Tip: After saving, open image in MS Paint to resize.
    2. UsefulInfo.jpg Note: You can check the width of an image by navigating to your image using windows explorer, right-click the image and select Properties. Select the Details tab to view the image width as shown below.

      Screenshot showing where to view an image’s width properties

    3. Named according to the format ‘XXX-X-ImageDescription<user guide abbreviation>’. The first three numbers will represent the section number and the last number, the nth image in that section:
      • A file named 431-1 is the first image in section 4.3.1
      • A file named 62-3 is the third image in section 6.2
Back to page contents

Convert

To convert an MS Word document to wiki markup, click File, Save As and select the file type ‘MediaWiki’. File names should have no spaces and limited to letter characters (e.g. FurtherHelp.txt).

After Converting

  1. Open the .txt file in Notepad++ (or similar).
  2. Heading levels should auto-convert as shown in the table below.

    In Word

    In Wiki markup

    3. Manage Membership Programmes

    ==Manage Membership Programmes==

    3.1 Rules for Dues and Contributions

    ===Rules for Dues and Contributions===

    3.1.1 Rules for Dues-Based Programmes

    ====Rules for Dues-Based Programmes====

    However, if required, you can correct or change. Note: If it is a long document, you could use find and replace – Do NOT use the ‘Replace all’ option. For example:
    1. [Ctrl]+h or click Search > Replace
    2. Enter: ==== in Find and === in Replace
    3. Click Find next
    4. Check you are in the right location i.e. where === is required, then click Replace
    5. Click Find next to go to the next location where === is required to replace ====.
  3. When a new article with 3 or more headings is uploaded from Notepad++ to the wiki, a TOC will be automatically generated at the top of the article. To prevent this from happening enter __NOTOC__ as the top line of your .txt file (double-underscore NOTOC double-underscore).
  4. Insert <div style="text-align: right;">[[#toc|Back to page contents]]</div> at the end of each section (i.e. before the heading of the next section). Use discretion as this may not be required at the end of every section.
  5. Check that italics Layout and bold Note: tags have correct number of characters.
  6. To change the colour of the text use the <span> tags, for example: <span style="color:green">Your text here</span> to display Your text here.
  7. To indent, use : (colon) for each level of indent.
  8. The conversion process assumes that any wiki code included in the original MS Word document is MS Word text, not wiki code, and will enclose it in the <nowiki></nowiki> tags.
    1. Use find and replace to find <nowiki> and replace all with nothing. Repeat this process for </nowiki>.
    2. Check that the code is otherwise correct.
  9. See the relevant sections below for further details on requirements for tables, links, bullets and numbering, uploading images and inserting images.

Tables

Tables will convert, however you will need to edit the first line of the table in the wiki markup.

Column 1

Column 2

Column 3

Content R1C1

Content R1C2

Content R1C3

Content R2C1

Content R2C2

Content R2C3

Content R3C1

Content R3C2

Content R3C3

Using find and replace: find class="prettytable" replace all with: class="wikitable" style="width: 70%;".

Bullets and Numbering

Bullets and numbers convert. However if you add the raw .txt file to DARSWiki you will see that:

  • Where numbered paragraphs were nested (e.g. 1 > a. > i.) in MS Word, there is only one number format in the wiki article, i.e. all levels are formatted as 1. 2. 3. etc. Furthermore; where a subordinate level, bullet point, image or table breaks the flow, the numbering restarts at 1.
  • Levels and bullet points, and the images and tables within them, may not align quite as you want them to.

Therefore, in most cases you will need to change the wiki markup to HTML and CSS code, to get the numbered and bulleted paragraphs to display correctly. Where there is no subordinate level, image or table to break sequencing, you can use the : colon to indent, if required.

The steps below apply to bullet points (unordered lists) as well as numbered lists except that the <ol></ol> tags should be replaced with <ul></ul> tags (ol = ordered list, ul = un-ordered list).

UsefulInfo.jpg Note: If you have a bullet-pointed list in your Word .doc, this will convert to wiki markup whereby each list item appears on a separate line, beginning with an asterisk. You do not need to enclose such lists in <ul></ul> tags. You will only need to do this in instances when you have a more complex list structure, for example where on ordered list has an unordered list within it, as shown below.
  1. List item 1
  2. List item 2
    • Bullet point 1 of List item 2
    • Bullet point 2 of List item 2
  3. List item 3
  4. List item 4

The steps to follow in order to code ordered/unordered lists are as follows:

  1. Start with an <ol> tag before the first list item at the top level. This code specifies that you wish to start an ordered list.
  2. Enclose each list item (in each level) in <li></li> tags.
  3. To display nested levels you will wrap CSS <div></div> tags around HTML styled lists.
    1. For an a.b.c. level start with <div><ol style="list-style-type: lower-alpha;"> before the first list item.
      1. For a i. ii. iii. level start with <div><ol style="list-style-type: lower-roman;"> before the first list item.
      2. Close the level with </ol></div> after the last list item. This code specifies that you wish to close off your i. ii. iii. list.
    2. Close the level with </ol></div> after the last list item. This code specifies that you wish to close off your a. b. c. list.
  4. Further list items will now be numbered. Close the final level of your numbered list with an </ol> tag. This will specify that you wish to end your numbered list.
UsefulInfo.jpg Note: You will need to use your Word document to compare the list structure required (that in your Word .doc) and the converted wiki markup list structure. This will enable you to identify where you require additional CSS tags to define your nested lists.
  • You will also need to use <div></div> tags where there are bullets, images or tables in the paragraph to align them properly.
  • Remember bullet points are unordered lists, therefore enclose them in <ul></ul> rather than <ol></ol> tags.

An example of an ordered list is provided below, with the tags/code required to define the list below it:

  1. Example of nested numbered list.
  2. 1st level row 2
    1. 2nd level row 1
    2. 2nd level row 2
      1. 3rd level row 1
      2. 3rd level row 2
    3. 2nd level row 3
  3. 1st level row 3
  4. 1st level row 4


<ol>
<li>Example of nested numbered list.</li>
<li>1st level row 2</li>
<div>
<ol style="list-style-type: lower-alpha;">
<li>2nd level row 1</li>
<li>2nd level row 2</li>
<div>
<ol style="list-style-type: lower-roman;">
<li>3rd level row 1</li>
<li>3rd level row 2</li>
</ol>
</div>
<li>2nd level row 3</li>
</ol>
</div>
<li>1st level row 3</li>
<li>1st level row 4</li>
</ol>

Links

You can create wiki code hyperlinks to pages, sections and websites in MS Word. You can choose to call the link an alternative name if you do not feel that the link name itself is intuitive. You can create a link:

  1. To another wiki page [[PageName]]. No ‘link text’ has been defined here so will display as PageName.
  2. When linking to sections within other wiki pages, always include link text, otherwise the # will appear in the link text:
    • To another section in the same page with link text [[#SectionHeading|Link text]] (For example: [[#Constituent Search|search for a constituent]] renders as ‘search for a constituent’.).
    • To a specific section in another wiki page [[PageName#SectionName|Link text]].
  3. External links:
  4. The conversion process will automatically recognize a URL or email address from your Word document.

  5. Links to images are formatted as [[File:FileName.jpg|border|alt="Screenshot of something"]]. See Inserting Images into Wiki Articles for further information.
  6. Where a link needs to be entered, and you don’t know the link yet, you can still include the text in the link wiki markup code. It will show as a broken link on the wiki page, then you simply correct it when known.
Back to page contents

Uploading a New DARSWiki Article

Uploading Text to DARSWiki

  1. Copy the text from Notepad++
  2. Navigate to a DARSWiki page that you will be linking to this new article from, for example the User Guides page
  3. Log in and select the Edit tab to edit this existing page.
  4. Enter an article link for your new article, i.e. enter the code: [[YourNewPageName]], in the required location and select Save page at the bottom of the screen.
  5. This action will save a new article link on the User Guides page, for example.
  6. The new link will display in red. Click on it to open the new blank wiki page for your article.
  7. Paste the copied text into the blank page/article and select Save page to save the page.
  8. Review and edit as required, referring to sections above for coding hints and the sections below regarding images.

Uploading Images to DARSWiki

Before uploading an image, make sure it is 600px or less in width. You can resize using MS Paint. To upload your images:

  1. Open DARSWiki for editing.
  2. Click the Upload file link in the menu on the left.
  3. To view a list of images already uploaded, click on the List of uploaded files link.
  4. Browse to and select the image file. Ensure you enter a summary – you can use the ‘alt’ text that you have/will encode/d in the wiki markup.
  5. Click Upload file.

Inserting Images into Wiki Articles

You can code the image in the MS Word .doc or the converted markup .txt file before uploading it to DARSWiki OR you can add it directly to the DARSWiki page.

  1. Adding Images Directly to the DARSWiki Page:
    In the uploaded wiki markup, click where you want to insert the image in your article and type [[File:Filename.jpg|border|alt=Enter alternative text description.]] replacing ‘filename’ and ‘enter alternative text description’ with the correct text; or click the Embedded file button and insert the image file name into the code – then add the border and alt details.
  2. ”Screenshot showing the location of the Embedded File button on the Wiki Edit screen”

  3. Adding Images to Pre-coded File Name Links:
    If you already coded your images in your Word or converted markup .txt file, your image file names will appear in red on your uploaded DARSWiki article, for example as: File:MyFirstImage.jpg.
    • Single-click the red link and locate your uploaded image by selecting Choose file.
    • Once located, select Upload File to add the image to your article.
    • Return to your article by clicking the article link at the bottom of the screen.
ImportantInfo.jpg Important: You should ensure that there is a thin grey border and always add alternative text as in the example below. Note that the code below contains an additional instruction of '|center|' which would align that image centrally relative to the page margins.

[[File:322-1.jpg|border|center|alt="Enter alternative text description of image."]]

Useful Codes for Editing DARSWiki Articles Post-upload

Code

Description/Function

Code Renders As:

'''Your Text'''

Enables user to specify bold text

Your Text

''Your Text''

Enables user to specify italic text

Your text

<u>Your Text></u>

Enables user to specify underlined text

Your text

<big>Your Text></big>

Enables user to specify big text

Your text

<span style="color:green">Your Text></span>

Enables user to specify coloured text

Your Text

'''<u><span style="color:green">Your Text></span></u>'''

Example showing the use of multiple codes and tags to specify bold, underlined and coloured text

Your Text

Back to page contents

DARSWiki Article Template

A template article has been created for you which provides the general structure and layout of DARSWiki articles. This article can be accessed by clicking following link: Article Template. The template is split into two main sections:

  • Section 1: Provides the general article layout including major and minor section headings and commonly included items within DARSWiki articles such as links, tables, images, ordered lists etc.
  • Section 2: Provides the Wiki markup code used to define the complete layout of the Section 1.
UsefulInfo.jpg Note: Wiki markup code can be copied directly from Section 2 of the Article Template and pasted into either Notepad++ or directly into the Wiki Edit screen for articles you are in the process of creating/updating.
ImportantInfo.jpg Important: If you are converting an existing MS Word document, the wiki markup code can also be pasted into your Word document before converting. The conversion process will assume that wiki markup code included in your Word document is Word text and enclose the code in <nowiki></nowiki> tags. Refer to Point 8 in the section After Converting for details on how to rectify this in your Notepad++ .txt file (prior to upload of the wiki markup to the DARWiki).

Use the template article in tandem with the style guidelines detailed above to produce your DARSWiki user guides and QRGs.

Personal tools
Namespaces
  • Page
  • Discussion
  • Variants
    Actions
    Navigation
    DARS User Support
    DARS Support Centre
    Advancing Oxford
    Tools