Warning: Trying to access array offset on value of type null in /home/site/wwwroot/lib/plugins/move/action/rename.php on line 42

Warning: Cannot modify header information - headers already sent by (output started at /home/site/wwwroot/lib/plugins/move/action/rename.php:42) in /home/site/wwwroot/inc/actions.php on line 38
how_to_contribute [topas wiki]

User Tools

Site Tools


how_to_contribute

Differences

This shows you the differences between two versions of the page.


Previous revision
how_to_contribute [2024/02/16 08:32] (current) johnsoevans
Line 1: Line 1:
 +====== How to contribute (registered users only)======
 +
 +Wiki software is a type of collaborative software allowing web pages to be created and edited using a simple web browser interface. This means that everyone who is a member of the wiki can contribute. 
 +
 +Because of hacking problems we've had to disable automatic user registration and login.  To get an account please email John on his Univesity email address.  Tell him the username you want and the email you want to register under.  If you want to use a non-university or non-company email, please provide sufficient evidence that he know's you're not a computer.  For example, include your favourite space group.
 +
 +If you're new to wiki software, there are some instructions below on how to get started.  We suggest you go to the [[playground:playground|PlayGround]] page before you make your first real pages.
 +
 +If you're familiar with wikis, some site-specific guidance is:
 +  * To add a topic that others can find by browsing we suggest you add to the alphabetical list at: [[alphabetical_listing_of_key_words|Alphabetical listing of keywords]]
 +  * If you want to contribute a macro go to: [[macros|User Macros]]
 +  * Add a page anywhere you like by typing the a new url in the top bar like "https://topas-test.awh.durham.ac.uk/doku.php?id=mypage" then clicking the grey pencil icon on the right to "Create this page"
 +  * Try to keep images and other files as small as sensible
 +  * Be aware that the moderators will remove any pages they think are inappropriate
 +
 +Most pages can be editted by users but some (e.g. manual pages) are read only.
 +
 +Enjoy!
 +\\
 +----
 +\\
 +==== Editing wiki pages ====
 +
 +Firstly, in order to read this website you need to have a user account, so please click on the login button at the top right of this page.
 +
 +It is very easy to contribute into this website, just follow the instructions below:
 +
 +  - Click on the page that you want to contribute information to.
 +  - Click on the "edit page" icon to the right of this window.
 +  - Type what you want into the white box and press save.
 +  - You can change text styles, upload images and files and more complex text formatting (see [[how_to_contribute#text_formatting]]). 
 +  - The information that you have typed will appear on the page you have edited.
 +\\
 +----
 +\\
 +==== Creating wiki pages ====
 +
 +To create new wiki pages linking from existing pages:
 +
 +  - Create an internal link by putting double square brackets around the link or press {{:link.png?18|internal link}} in the editor toolbar. 
 +  - Instead of clicking on "edit this page", click on "create this page".
 +  - Then follow the instructions for editing wiki pages ([[how_to_contribute#editing_wiki_pages]]).
 +
 +\\
 +Alternatively, insert an external link  ({{:linkextern.png?18|}})  to an existing web page, so that people can access what you want to contribute.
 +\\
 +----
 +\\
 +==== Text formatting ====
 +
 +Use this editor toolbar (below) when in "edit this page" to do basic text formatting, just click on the button and insert your text.
 +
 +\\
 +{{ :toolbar.png?450 |editor toolbar}}
 +\\
 +
 +Special buttons in the editor toolbar (pictured above):
 +
 +  * {{:h1.png|}} - This is a large header, used for titles (h1)
 +
 +  * {{:h3.png|}} - This is a smaller header, used for subtitles (h3)
 +
 +  * {{:macro.png|}} - This is a button for formatting TOPAS INP code and macros that you may see (see [[how_to_contribute#formatting_macros]] below)
 +\\
 +For help with text formatting go to [[wiki:syntax]]
 +\\
 +----
 +\\
 +==== Formatting TOPAS snippets ====
 +
 +On lots of the wiki pages you'll see that TOPAS INP file snippets are colour coded in a similar way to in jEdit. It is very simple to make your macros colour coded too.  If you can see {{:macro.png|}} in the editor toolbar press it and this will appear:
 +
 +  <code topas>Macro Code</code>
 +
 +Insert your TOPAS snippet where it says Macro Code.
 +
 +If you don't see {{:macro.png|}} then you can just type the formatting flags in yourself as below:
 +   <code topas> ...[your topas code over several lines if needed]... </code> as text.
 +\\
 +----
 +\\
 +==== Word files to dokuwiki format ====
 +
 +Text files can be transferred directly from Microsoft word files to dokuwiki format. Converting Word files to dokuwiki requires a programme available for dowload from the internet - http://www.dokuwiki.org/tips:htmltowiki (html to dokuwiki). It needs to be used on Windows (open it with winzip, Use Evaluation version and open the .exe). 
 +
 +Steps:
 +  - Download the programme onto Windows.
 +  - Save the word document you want on dokuwiki onto Windows as a name with NO SPACES (or special characters) in it!
 +  - Click Save as, and save it as file type, web page – a folder will then be created holding the pictures for this file.
 +  - Save it one more time.
 +  - Open this document with notepad.
 +  - Copy all the contents from notepad (Ctrl + A).
 +  - Paste it into the top section of html2dokuwiki.exe, press enter
 +  - The html file will be converted into dokuwiki syntax codes, copy all of this (Ctrl + A).
 +  - Paste it into the dokuwiki site, if it's a large document, it may have to go into several separate pages (e.g. an 131 page document had to be put into 3 separate pages) - for problems loading a page after putting a large document into it ask admins.
 +
 +\\
 +Word files with images are harder to transfer straight to dokuwiki and require the help of admin. Follow the steps above for putting text onto topaswiki, but image files must be added to the right folder by admin. Contact admin if you need to do this (they will need to add the folder containing images that is created when the document is saved as a webpage).
 +
 +Alternatively add images manually to the topaswiki page you have created using this button {{:image.png|}} in the editor toolbar in <html><span style="color:blue;">edit this page</span></html>.
 +\\
 +----
 +\\
 +For any questions or queries, ask them in the [[https://topas-test.awh.durham.ac.uk/flarum/public/|TOPAS forum]] or look at the [[frequently asked questions]] link.
 +