Help:Tutorial - Revision history

Joel Hedlund (NSC) at 15:33, 11 January 2012

2012-01-11T15:33:02Z

Joel Hedlund (NSC): /* Quickstart */

2012-01-11T15:23:36Z

‎Quickstart

Joel Hedlund (NSC): /* Quickstart */

2012-01-11T15:07:35Z

‎Quickstart

Joel Hedlund (NSC): /* Self-education */

2011-09-28T09:39:03Z

‎Self-education

Joel Hedlund (NSC): /* Quickstart */

2011-09-28T09:37:44Z

‎Quickstart

Joel Hedlund (NSC): /* Quickstart */

2011-09-28T09:37:05Z

‎Quickstart

Joel Hedlund (NSC): /* Quickstart */

2011-09-28T09:35:03Z

‎Quickstart

Joel Hedlund (NSC) at 09:34, 28 September 2011

2011-09-28T09:34:17Z

Joel Hedlund (NSC) at 07:24, 20 September 2011

2011-09-20T07:24:35Z

Joel Hedlund (NSC) at 07:24, 20 September 2011

2011-09-20T07:24:12Z

@@ Line 11: / Line 11: @@
 : This is so that you won't have to scour pages upon pages of running text to chase down that one tag that someone set to something a little too funky at 17:08 one Friday afternoon. Here is the key to the secret: this wiki is entity based. All tabulatable information on an entity is found at the top of each entity's page, eg. software info at the top of each software's page, and so on and so forth. Press the Edit button on top of the page to go to the right place. All other buttons just let you edit that section, which is handy for large pages, but not much else.
 ; Installed software should be specified on the individual resources' pages.
-: If you have installed a new software on a resource, go to that resource and add the software name to the list of installed software. It may also be possible for you to generate lists of installed software from your module system (or similar) and then just paste that in. See for example [[File:Get_snicdocs_software_for_cluster.py |this helper]].
+: If you have installed a new software on a resource, go to that resource and add the software name to the list of installed software. It may also be possible for you to generate lists of installed software from your module system (or similar) and then just paste that in. [[User:Joel Hedlund (NSC)|Joel Hedlund]] has written a small helper for this.
 ; Tabulatable information is called properties
 : They are documented and have semantics. See [[#Self-education]] below.

@@ Line 11: / Line 11: @@
 : This is so that you won't have to scour pages upon pages of running text to chase down that one tag that someone set to something a little too funky at 17:08 one Friday afternoon. Here is the key to the secret: this wiki is entity based. All tabulatable information on an entity is found at the top of each entity's page, eg. software info at the top of each software's page, and so on and so forth. Press the Edit button on top of the page to go to the right place. All other buttons just let you edit that section, which is handy for large pages, but not much else.
 ; Installed software should be specified on the individual resources' pages.
-: If you have installed a new software on a resource, go to that resource and add the software name to the list of installed software.
+: If you have installed a new software on a resource, go to that resource and add the software name to the list of installed software. It may also be possible for you to generate lists of installed software from your module system (or similar) and then just paste that in. See for example [[File:Get_snicdocs_software_for_cluster.py |this helper]].
 ; Tabulatable information is called properties
 : They are documented and have semantics. See [[#Self-education]] below.

@@ Line 4: / Line 4: @@
 Here is a list that will get you bootstrapped:
 ; Only cert-regged people using https can edit. Others can only Talk.
 : Install your certificate in your browser if you haven't already, then go here: [https://snicdocs.nsc.liu.se https://snicdocs.nsc.liu.se]. You will be logged in automatically. See your name on top of page. No? Notify [mailto:root@nsc.liu.se root@nsc.liu.se] and they'll set you up. Unless you are thus set up, you can only edit Talk pages (aka Discussion pages, see tab on top of each page). Talk pages are a means for user feedback on site contents.
@@ Line 11: / Line 10: @@
 ; The obvious place to enter information is at the top of the page.
 : This is so that you won't have to scour pages upon pages of running text to chase down that one tag that someone set to something a little too funky at 17:08 one Friday afternoon. Here is the key to the secret: this wiki is entity based. All tabulatable information on an entity is found at the top of each entity's page, eg. software info at the top of each software's page, and so on and so forth. Press the Edit button on top of the page to go to the right place. All other buttons just let you edit that section, which is handy for large pages, but not much else.
 ; Tabulatable information is called properties
 : They are documented and have semantics. See [[#Self-education]] below.

@@ Line 32: / Line 32: @@
 # Press "Show preview".
 # Scroll to bottom.
-# See list of used templates and properties set.
+# See list of templates used and properties set.
 # You can click the template names to see the their documentation, or press the corresponding "(edit)" to see the source code. The source code looks awful because mediawiki uses an ad-hoc parser where whitespace matters (basically csh + LaTeX), but mostly it's simple string crunching and logic. Not even iteration. [http://www.google.se/search?q=mediawiki+StringFunctionsEscaped Google] will [http://www.google.se/search?q=mediawiki+StringFunctions happily] tell you [http://www.google.se/search?q=mediawiki+ParserFunctions exactly] what each [http://www.google.se/search?q=mediawiki+RegexFunctions bit of the template] is [http://www.google.se/search?q=semantic+mediawiki doing]. Or you can ask [[User:Joel Hedlund (NSC)|Joel Hedlund]] if you think that'll be quicker.
 # At the very bottom, you can see a box that shows what properties are set on this page. You can click any property name to see its definition and semantics.

@@ Line 20: / Line 20: @@
 : We are holding your hand! For most stuff we have thought of, we have written an [[:Category:Example page|Example page]] that you can just copy and fill in with whatever details should go there. Presto!
 ; Nothing goes live until you press "Save page"
-: Feel free to play around. To feel extra safe, use a semi-hidden page in your own private namespace, like for example this one: [[User:Joel Hedlund (NSC)/test]]. See what I did there? I just appended "/whatever" to my user page, and created a page that will not come up in searches, and whose name does not collide with anything else. Don't go adding any info using templates or categories on that kind of page though! That will drag them right back into the limelight, and we don't want any half-finished experiments turning up on stage, especially not if you think are being secretive with them! But they are very nice for drafting articles like this one. By the way, click your name on top of the page to go to your user page. How do I create the page then, you ask? Why, go read [[Help:Creating pages]], under the heading "Create the page".
+: Feel free to play around. To feel extra safe, use a semi-hidden page in your own private namespace, like for example this one: [[User:Joel Hedlund (NSC)/test]]. See what I did there? I just appended "/whatever" to my user page, and created a page that will not come up in searches, and whose name does not collide with anything else. Don't go adding any info using templates or categories on that kind of page though! That will drag them right back into the limelight, and we don't want any half-finished experiments turning up on stage, especially not if you think are being secretive with them! But they are very nice for drafting articles like this one. By the way, you can click your name on top of the page to go to your user page. How do I create the page then, you ask? Why, go read [[Help:Creating pages]], under the heading "Create the page".
 ; Read the docs for once
 : You know how you always tell your users to read the docs? Yeah. Go here: [[Help:Editing policies]]. Tell [[User:Joel Hedlund (NSC)|Joel Hedlund]] if things do not make sense or are missing.

@@ Line 6: / Line 6: @@
 ; Only cert-regged people using https can edit. Others can only Talk.
-: Install your certificate in your browser if you haven't already, then go here: [https://snicdocs.nsc.liu.se https://snicdocs.nsc.liu.se]. You will be logged in automatically. See your name on top of page. No? Notify [mailto:root@nsc.liu.se] and they'll set you up. Unless you are thus set up, you can only edit Talk pages (aka Discussion pages, see tab on top of each page). Talk pages are a means for user feedback on site contents.
+: Install your certificate in your browser if you haven't already, then go here: [https://snicdocs.nsc.liu.se https://snicdocs.nsc.liu.se]. You will be logged in automatically. See your name on top of page. No? Notify [mailto:root@nsc.liu.se root@nsc.liu.se] and they'll set you up. Unless you are thus set up, you can only edit Talk pages (aka Discussion pages, see tab on top of each page). Talk pages are a means for user feedback on site contents.
 ; You cannot edit dynamically generated content in-place.
 : Scattered across the wiki you will see blue tables. They are views. You cannot edit them.

← Older revision		Revision as of 07:24, 20 September 2011
Line 1:		Line 1:
−	This document is designed to get you up to speed with adding content as quickly as possible. Therefore, it contains as little text as possible. If you have any trouble that your coworkers can't solve for you in 30s, please contact [[User:Joel Hedlund (NSC)\|Joel Hedlund]] and we'll set you straight in a jiffy. If you need help creating pages, see [[Help:Creating pages]]. If you need help ~~with~~ the mediawiki text format or ~~generating~~ dynamic tables, see [[Help:Editing]]. If you're unsure as to what goes onto this wiki and what does not, see [[Help:Content policy]]. This page is for something else, namely to explain what sets snicdocs apart from other mediawiki installations out there. If there is something in here that is unclear, chances are that it is better explained in [[Help:Design]], but I didn't want all those words in here. Go there if you want them.	+	This document is designed to get you up to speed with adding content as quickly as possible. Therefore, it contains as little text as possible. If you have any trouble that your coworkers can't solve for you in 30s, please contact [[User:Joel Hedlund (NSC)\|Joel Hedlund]] and we'll set you straight in a jiffy. If you need help creating pages, see [[Help:Creating pages]]. If you need help understanding the mediawiki text format or how to generate dynamic tables, see [[Help:Editing]]. If you're unsure as to what goes onto this wiki and what does not, see [[Help:Content policy]]. This page is for something else, namely to explain what sets snicdocs apart from other mediawiki installations out there. If there is something in here that is unclear, chances are that it is better explained in [[Help:Design]], but I didn't want all those words in here. Go there if you want them.

	== Quickstart ==		== Quickstart ==