Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

By now, you should have your private wiki page to play around with. When you are ready to submit your page for grading, you should set page restrictions for Everyone to Can View. Keep the Page title as your name, which will help in grading.


While editing, constantly preview and save your work to see how the final product actually looks like.

Tip

Save regularly while editing your Species Page! You are also advised to create your content offline first (e.g., on Word) before uploading them onto Wiki.nus. This will help save you from a good number of heart-attacks if the Wiki.nus server ever fails to connect (especially when deadlines draw near!)

The Wiki.nus server tends to be intermittently unstable late at night or early in the morning. If you do encounter server connection failure while editing your page, do not panic and refresh/close the page. While you are unable to save the page, you can still edit it. Just wait until the server reconnects (a blue pop-up will alert you that you can start saving again), and then save away.

The following sections will detail various aspects of populating and formatting your page.




Table of Contents
outlinetrue
indent10px

Page Formatting

Page formatting is crucial to keeping a page tidy and appealing. The following link provides detailed instructions on formatting, such as how to create sections, links etc: Edit a wiki page. In addition to the instructions, here are a few more useful tips on formatting:


  • Creating Sections allows you to better organize your page. They also come in various configurations, and you can reorganize the order of sections ( using "↑ Move up" and "↓ Move down") easily. Use them liberally!
    • Adding a horizontal line rule (under the "+" button with hover-over text "Insert more Content")  can help visually segregate your sections better.

  • Creating a Table of Contents (under the "+" button with hover-over text "Insert more Content") is useful for organizing your information as well.
    • To make your sections link to your ToC, Make sure your 1st row of text is in "Heading 1" (dropdown options on top left). Subsections will also be reflected in the ToC, if you use the smaller Headings word formatting.

  • Explore the different macros available for use, which can really help present your page better. For example, the 'Info' macro creates a little info-box like this one to help you emphasize certain points.
    • Once you are more familiar with the macros, make use of the hotkey "{" - pressing it immediately invokes a context menu where you can choose your desired macro.




Uploading and Linking Media

Uploading Media Attachments

Uploading media is easily done in the wiki. Just click the "Insert files and images" icon (or Ctrl-M) which will invoke the input menu, and you can upload your media attachments.

You are discouraged from uploaded overly-high resolution images (e.g., DPI600) or formats (e.g., .tiff). These take up unnecessary space and websites cannot display them in such great detail anyway.

Try to keep your images to (1) max 2000px dimensions, (2) 72DPI and (3) ideally with .jpg or .gif formats. Photoediting programmes such as Adobe Photoshop and GIMP (freeware) can easily perform such procedures.

Before you upload anything, please read the following carefully: all filenames must be renamed to the following format: T4254-[Speciesname]-[mediatype*]-[#].[filename extension], where

      • [Speciesname] is the scientific name of the species; no spaces should be used
      • [mediatype] refers to the type of media you are uploading, e.g. image (img), video (vid), sound (snd), document (docu) etc.
      • [#] is the number you use for multiple files, 1, 2, 3...etc.
      • [file type extension] refers to the 3/4 letter extensions (e.g., .jpg, .png, .mov., .doc etc.)

As an example, this can be the following list of files that you might upload:

      • T4254-Hercostomusmeieri-img-1.jpg
      • T4254-Hercostomusmeieri-img-2.png
      • T4254-Hercostomusmeieri-img-3.jpg
      • T4254-Hercostomusmeieri-vid-1.mov
      • T4254-Hercostomusmeieri-vid-2.mp4
      • T4254-Hercostomusmeieri-snd-1.mp4
      • T4254-Hercostomusmeieri-docu-1.pdf

While renaming these files may be tedious, they are important in helping us maintain the data in the future (e.g., if the species pages need to be migrated into another platform). I would thus advise you to prepare all your media before uploading them onto the server.

Warning
Please adhere strictly to these instructions: A purge of all media with non-standardized names will be conducted after page submission and prior to grading!


Replacing Media Attachments

Should you want to update your uploaded media, you can overwrite your uploaded attachments. With your new desired file, give it the same name as the existing uploaded one. Once you upload it, the new file will replace the old file, along with all instances of attachment links. Note: you will need to save the page before you can see the updated image.

Do take note that the new attachment will retain the older attachment's display dimensions. So for example, if you are replacing a 300px by 300px image with a 100px by 100px image, the new image will be displayed at 300px, and look overly-blown up. You can correct this by clicking on the new image and edit the display dimensions.


Removing/Renaming Uploaded Media Attachments

Should you have uploaded media attachments in error, you can easily remove or rename them. Outside of Edit mode, click on the three grey dots, and select "Attachments":


This will bring you to the attachments list for you page. Here you can preview all your uploaded media. As you can see, I've uploaded an erroneous attachment. Simply click "Delete" on the right of the line to trash the offending file, or "Properties" which will invoke a properties menu - where you can change the name of the uploaded attachment.


Linking On-Line Media

Unless the linked media are videos from established video sites (Youtube or Vimeo), or interactive maps from GoogleMaps/Earth, please refrain from linking external media, as the link will go dead if the external source is removed. All images should be downloaded from source sites and then re-uploaded into the Wiki.Nus server (see above).




Citations and References

As described earlier, referencing is an important part of literature. Here, you can make use of the Single Cite Macro. Place your vertical-line cursor where you want the footnote to appear, and then click on the + sign (insert more content) > Other Macros > Single Cite. A context menu will appear, prompting you to click on "Insert" (make sure the "atlassian-macro-output-type" option is set to INLINE). Give your citation a unique ID (the simplest option would be just a number). A small macro menu will then appear, looking like this:

In the provided space, type in your reference. Once you click Preview or Save, the box will disappear and show this tiny icon instead:

Single cite
citeID1

Ang Y., Ho, J. K.I., 2020. Here is where you should type in your reference. Taxo4254 Instructions Manual

. Do not worry that that the Citation macro appears to take up the whole line in Edit mode - as long as you set the option to , the citation mark will appear as inline and not on the next line.


You've now created your citation - now you will need to create your Reference list. Create a new Section with the title as References (by making sure the format for the title is set to Heading 1). Next, click on the + sign (insert more content) > Other Macros > Cite Summary. After a context menu prompts you to 'insert', this next macro should appear

:. This is the placeholder for your Reference section

Single cite
citeID2

Ang Y., Ho, J. K.I., 2020. This is another reference. Taxo4254 Instructions Manual

. Once you click Save or Preview, the actual Reference list will be shown, as example:

Cite summary


Please refrain from using the Anchor Macro, as it will become messy with multiple anchors!




Adding Labels

You can add labels to your page, which allows users to search for your page more easily. You can do this easily by clicking on the labels icon on the bottom right of your page (outside of Edit Mode!): . An input menu will then pop up for you to enter your labels. The Wiki will treat all separate words as individual labels. As such, you should keep all your labels as one word. Click "Add".

Your new labels should then appear before the pencil icon: . Notice that all Capitalizations will be downcased.

To remove them, simply click the Pencil Icon again and the "x" to the right of every label to remove them.


I would suggest adding in the following labels:

  • the following text: "speciespage"
  • your name, year in the following format: nameYEAR (e.g., yuchenang2018)
  • your species name in the following format: genusspecies (e.g., meieraruldophus)
  • relevant taxonomic group such as family-level grouping (e.g., sepsidae)



Page Title-renaming and Authorship

Retaining Authorship

Upon graduation from NUS, your NUSID will be revoked, which means that page ownership will be reverted to a default user. As such, you should indicate your details at the bottom of your own species page to retain a record of your authorship:

  1. Create a new section at the bottom of the page. Make sure that it is a Single Column style.
  2. Making sure that your text is set to Align Right, leave your details in the following format (replace red text with your own details):
This page was authored by YOUR NAME(OPTIONAL: YOUR NON-NUS EMAIL)
Last curated on DATE YOU LAST EDITED THIS PAGE


I have done an example at the bottom of the page for you to see.

Renaming your Species Page

Once your Species Page has been graded, you should rename the title of your page according to the following format:

  • Species name - Common name if available

Here is an example without common names:

  • Sepsis spura

Here is an example with common names:

  • Merleo vomitus - Merlion


And that's it! You're well-equipped to create your own species page. Do remember to check the official Wiki.nus user guide pages, or the Atlassian Confluence manual PDF for more detailed information.


This page was authored by Yuchen Ang [myownemail(at)mail.com]
Last curated on 23 August 2018