Difference between revisions of "Wikipage instructions"

Revision as of 14:02, 1 April 2011

If you've clicked to get here, you are willing fill in some details about yourself or someone else in the AO group such as your/their personal page, the publications page or anything else. I will put down a list of easy (I hope) instructions to keep upto date and maintain the webpage.

Basic wikitext

There are already a few pages on this wiki that can help you with putting up text/links/pictures on any page. The best reference page is;

Wikitext examples

which will get you upto speed. Along with this, when you create/edit a page, there is an edit bar that will input wikitext special characters for you, so you don't need to remember them all. Here are a few quick examples that are commonly used in this wiki if you don't want to read through the examples page;

• <code>some example code</code> will make the sample code look like this:- some example code
• <nowiki><some_markup> some code </some_markup></nowiki> will ignore all markups in 'nowiki' and result in:- <some_markup> some code </some_markup>
• ''Italic text'' results in:- Italic text
• '''Bold text''' results in:- Bold text
• You are required to put a double 'return' in the edit text to see regular text on a new line (except with bullet points, numbered lists, titles, etc)
• <!-- some hidden text --> will comment text and can only be seen in edit mode, can be used to keep old text without deleting it
• <pre>some large code</pre> will put code into a special box and will show:-

  some large code

• ==Title== and ===Subtitle=== will create a title and subtitle on a page, shown below:-

Title

Subtitle

• ---- will add a line into the page:-

• You can use :, * and # to indent, bullet point and number text respectively. The more characters you add (e.g. **, ***) the more you subdive the section. Adding more : will indent further, adding more * will bullet inside another bullet point and adding more # will split up numbered sections.

Basic links

Mediawiki makes it very easy to link to other pages as long as you are consistent on naming. The largest problem when using links (and are subsequently easily resolved) is when to use capital letters for page titles and whether or not to use underscores. Generally in links, use capital letters if the page has capital letters and don't use underscores (there are some exceptions, but even if you encounter them, you can just go back and replace them). Its best to test every link once you've created a page.

• [[Applied Optics]] creates a link like this :- Applied Optics
• [[Applied Optics|Welcome page]] creates a named link (seperated by | ) like this :- Welcome page
• [[#Basic wikitext]] creates a link to a subsection like this :- #Basic wikitext
• [[Main page#Contributing to the wiki|Contributing]] creates a link to a subsection on different page, named, like this :- Contributing
• http://www.nottingham.ac.uk/engineering/departments/eee/index.aspx creates a link like this (use nowiki tags if you don't want to link to a webpage, mailto: email address will also work like this):- http://www.nottingham.ac.uk/engineering/departments/eee/index.aspx
• [http://www.nottingham.ac.uk/engineering/departments/eee/index.aspx EEE department webpage] creates a link like this, notice the use of single square brackets and no | in the markup:- EEE department webpage

Getting started (and eventually finishing)

Ok, so now that you have a decent enough amount of wikitext markups under your belt, you need to follow these steps (skip any of these if you already have them, or can't be bothered to do them):-

1. Get yourself an optics wiki account. Request a login using your full name as the user name, then email either Roger Light, Steve Sharples or Matt Clark to get your account confirmed.
2. Login (link in top right hand of page)
3. Upload a picture of yourself. Use this page to upload a file. There's no naming convention yet, but I would recommend using first-name_second-name_year.png or .jpg. Other formats are accepted (use additional middle and second names if you have them)
4. Create your personal page. This is very easy, in the address bar, stick in http://optics.eee.nottingham.ac.uk/wiki/first-name_second-name. If you have middle names, double barrel surnames or anything of the like, use underscores instead of spaces and keep in hyphens. If you are in two minds about whether or not to use a nickname or an alternative name, I'd suggest using whatever you're officially known as (in journal papers or documents) then when you link to your page on this website, you can use your other name using the link markups from above. Your page won't exist so click on the 'create' tab near the page search bar.
   • Fill up your page. Use Matt Clark's page as a general template. You could copy his entire page (click on edit, then copy/paste onto you're page) then add/remove at your own convenience. Of course, not everyone will have an awards section and may not even have a publications section (I know I don't have one yet) but you can add other sections which you deem relevant to your page. Just add new titles to your page. If you have copy/pasted, replace Image:mattphotforpubs.png (near the top of the page) with your own link Image:first-name_second-name_year.png. Replace any other text you're comfortable with. A lot of the markup may still be a mystery and will be explained below so that you can sort the page out, but for now, you can at least have a page and the website looks half way complete.
   • If you want to redirect to an external webpage instead of filling up another page on here (not really recommended, as this website should remain live and maintained) then you can use the tags <extredir>http://someother.page/yourpage</extredir>. This will give the user two seconds to view whatever message you put up to let them know they are being redirected. Mike Somekh currently has this redirect in place.
5. Next, goto Personal Pages. You need to add your name to the table. To do this;
   • Delete |} at the end of the page
   • Add your own code;

   |-

   |align="center"|[[first-name second-name]]||your location||align="center"|your phone number||align="center"|your email ID

   |}

   • So as an example, Matt Clark's entry looks like this:-

   |-

   |align="center"|[[Matt Clark]]||Tower 607||align="center"|(0115) 95-15536||align="center"|matt.clark

   |}

6. Here's the tricky part, not coding wise, but with general workability of the webpage. Many people will have been known as something other that their full name in journal papers, presentations, etc. These could include initials or an alternative first name. To this end, you will need to create a page (similar to how you created your original page) with this name and use the markup #REDIRECT [[pagename]] where pagename is your name (your webpage). Be careful with this, you don't want to redirect uncessarily, someone may have the same initials/name as you and it's quite tedious to undo (links on every page it's mentioned on will need to be changed). Examples of this are S D Sharples, Steve D Sharples, M Clark, Matthew Clark. Double redirects are not allowed (redirect to a redirect). Notice on each of the links above, it shows where you have been redirected from at the top.
7. You also need to redirect your user page (related to your wiki account) to your personal page. You can do this easily as it is done in the same way as any other wiki redirect (using #REDIRECT [[pagename]]). So assuming someone has created a proper user (using a full name as username), you would goto http://optics.eee.nottingham.ac.uk/wiki/User:wiki-user-name including all caps, hyphens, etc. in your username. As an example Valerie Pinfield's user page would be http://optics.eee.nottingham.ac.uk/wiki/User:Valerie_Pinfield and redirects users to her page.
8. Now that you have a page, you need to update the publications page. There's a list of pages that you can add your publications to. Read up on the BibTex tags below or add it manually using indents and links (something I really really don't recommend) to make it look like the other links. Chances are however, one or more (or even all) of your publications are already there in the list, make sure there are no duplications. Put all publications under the correct year and keep it as chronological as possible or you can update any of the publications that are already there (add pdf file, url, abstract, etc tags to the entries).
   • Journal papers and articles go into Articles
   • Conference papers go into Inproceedings
   • Posters, seminars, and published presentations or reports go into Reports. Use @techreport{} as the BibTex type
   • Doctoral theses go into Thesis
   • Everything else goes into Other publications, which includes books, masters theses, manuals, etc.
9. Next, you can update/include/create information about your projects and research topics. See if you can put your information into one of these four categories; Biomedical applications, Integrated sensors, Laser ultrasonics or Microscopy and optical techniques. Once a format has been determined, I'll put it up on here otherwise see if you can follow the format if there is already one on these pages

Slightly less basic wikitext

There are few extra wikitext special characters/tags that you will need/see. They are separated into subsections below:-

Publications and BibTex

After much fiddling and rewriting of code, I've managed to make the BibTex extension work on this wiki. Firstly, there are some simple changes to a BibTex code that need to be made in order to make it both work on here and if/when someone downloads the code.

• The authors need to be separated. This is done so that external people can be main/co-authors of papers and not be linked in this wiki. I've created two new tags (preauth, postauth) that only work on this wiki, and will disappear when downloaded. You could have no linked authors by putting all authors into any of these two tags. To add a publication, use <bibtex> "bibtex code" </bibtex>

• REQUIRED - All internal names in the author tag need to be in normal order (i.e. first name first), preferably full (in order to be linked without redirects), and separated by 'and'. No commas or full-stops should be present inside the author tag!

• OPTIONAL - Main external author names are to be put in preauth = {....} tag. Again separated by 'and' but do not need to be full.

• OPTIONAL - Co-author external names are to be put in postauth = {.....} tag. Again separated by 'and' but do not need to be full.

• OPTIONAL - A link to a pdf can be put into pdf = {.....} tag. Similarly, links can be put into ps = {.....} and url = {.....} for postscripts and internal/external links respectively.

The squiggly brackets could be quotation marks in some peoples BibTex but this doesn't matter (tested by Matt).

Check out the examples below. Personal page links will work once they are made/redirected.

<bibtex>
@ARTICLE{Summers2010,   preauth = {David Summers}, author = {Matt Clark and Ian Stockford and 
Samuel Achamfuo-Yeboah}, postauth =  {Pereira Do Carmo, J},  title =  {Modulated light camera for 
space applications and assessment via    a  test bench system},  journal = {Acta Astronautica}, 
year = {2010},   volume = {66},  pages = {1399 - 1403},  number = {9-10},  note = {ASIC 
design;Imaging arrays;Innovation triangle initiatives;Large     structures;Modulated laser 
light;Modulated light camera;Modulation     schemes;Optical ranging;Phase Change;Rendezvous and 
docking;Roadmap;Space-borne    instruments;Test benches;Test  systems;University of Nottingham;}, 
abstract = {The modulated light  camera technology, developed by the University    of Nottingham, 
illuminates a target with modulated laser light and    measures the  distance to the target scene 
by the phase change of    the return,  across an imaging array. This enables the measurement    of 
distance to  different parts of the scene simultaneously, on a    pixel by pixel  basis. A 
prototype camera has been assembled under    the ESA Innovation  Triangle Initiative and supplied 
to SEA where    there has been an  assessment of the potential of this technology    for a range 
of space  applications, including Rover Vision, Rendezvous    and Docking, and  monitoring the 
deployment of large structures. The    supplied device  has been tested with appropriate 
modulation schemes.    Finally, a  roadmap has been devised to show the developments needed    to 
take this  test system forward to a fully fledged spaceborne instrument.     © 2009 Elsevier 
Ltd. All rights reserved.},  address =  {Langford Lane, Kidlington, Oxford, OX5 1GB, United 
Kingdom},  copyright  = {Compilation and indexing terms, Copyright 2010 Elsevier Inc.},  issn  = 
{00945765},  key = {Cameras},  keywords = {Application specific  integrated circuits;Electric 
power supplies to     apparatus;Innovation;Integrated circuits;Manned space 
flight;Pixels;Space    applications;Space rendezvous;Technological  forecasting;},  language = 
{English},  owner = {rp},  timestamp =  {2010.11.19},  url = {http://dx.doi.org/10.1016
/j.actaastro.2009.10.030}
}
</bibtex>

<bibtex>
@article{m41,
 title="Adaptive acoustic imaging using aberration correction in difficult materials",
 author="S D Sharples and M Clark and I J Collison and M G Somekh",
 journal="Insight",
 volume="47",
 number="2",
 pages="78-80",
 year="2005",        
 pdf="http://optics.eee.nottingham.ac.uk/optics/papers/Laser_Ultrasound/papers/2005_insight_aberration_correction.pdf"
 }
</bibtex>

Acta Astronautica 66(9-10):1399 - 1403, Langford Lane, Kidlington, Oxford, OX5 1GB, United Kingdom,2010

http://dx.doi.org/10.1016/j.actaastro.2009.10.030
Bibtex

Author : Matt Clark, Ian Stockford, Samuel Achamfuo-Yeboah
Title : Modulated light camera for space applications and assessment via a test bench system
In : Acta Astronautica -
Address : Langford Lane, Kidlington, Oxford, OX5 1GB, United Kingdom
Date : 2010

Insight 47(2):78-80,2005

Bibtex

Author : S D Sharples, M Clark, I J Collison, M G Somekh
Title : Adaptive acoustic imaging using aberration correction in difficult materials
In : Insight -
Address :
Date : 2005

• A quick/dirty way (may not always work) to mass post publications is get a *.bib file and to find/replace all @ with </bibtex> <bibtex>@ then move the extra </bibtex> to the end and copy/paste. Of course, this will only work if none of your tags have an @ in it.

• Uploading a pdf of a paper or poster/talk (which will be called a Tech report or type 'techreport' in BibTex) use this upload file link. We're trying to get a naming convention going, so the uploaded file name should be type_year_place_title.pdf. Then put the full address of the uploaded pdf in the pdf = {.....} tag. Here is a link to uploaded files, you want to copy/paste the link marked '(file)'. Now, I'm mostly sure that this address doesn't change, but seeing as I'm not 100% sure, I'm not sure if people should put the actual address or just put the file referrer address, http://optics.eee.nottingham.ac.uk/wiki/File:type_year_place_title.pdf. I'll leave it up to whomever is writing the page.

• To have a link to an internal or external page, put the address in the url = {.....} tag.

• Preferably, we want all pdfs and links in one maintained and backed up location, and this seems to be the best place for it.

Its a bit of a pain now, but it needs to be done in order for it work with links on here AND (when bibtex link is clicked) come out with a bibtex that can be used straight away. At some point name reversing should be implemented by for now, as long as tags are put in correctly, this should work properly.

Tables

Tables are relatively easy to create. Here is a decent help page:-

http://www.mediawiki.org/wiki/Help:Tables

But if don't want to read all that, here is a simple code that you can copy/paste/extend as you wish:-

{| width="100%" class="wikitable sortable"
|+ Table title
! width="25%"|Heading 1 !! width="25%"|Heading 2!! width="25%"|Heading 3!! width="25%"|Heading 4
|-
|Row 1 Column 1||Row 1 Column 2||Row 1 Column 3||Row 1 Column 4
|-
|Row 2 Column 1||Row 2 Column 2||Row 2 Column 3||Row 2 Column 4
|-
|Row 3 Column 1||Row 3 Column 2||Row 3 Column 3||Row 3 Column 4
|}

And will result in a table that looks like this:-

A few more tags

• To put a picture up on a page without linking it, use [[Image:some-random-picture.png|link=]]
• In most publicly seen pages, you don't really want a table of contents. In this case, you want to put __NOTOC__ at the top of your page