Git script guidelines - Revision history

Pyadmin: 53 revisions

2014-03-28T01:47:04Z

53 revisions

Speleo3: indent of REDIRECT

2012-01-13T11:39:40Z

indent of REDIRECT

Speleo3: wiki links, correction of redirect instruction

2012-01-13T11:37:10Z

wiki links, correction of redirect instruction

Tlinnet: /* Python Code */

2011-12-10T18:09:33Z

Python Code

Tlinnet at 18:08, 10 December 2011

2011-12-10T18:08:46Z

Tlinnet: /* Guide lines */

2011-12-06T20:20:27Z

Guide lines

Tlinnet: /* Guide lines */

2011-12-06T20:20:02Z

Guide lines

Tlinnet: /* Example of use */

2011-12-06T09:11:18Z

Example of use

Tlinnet: /* Guide lines */

2011-12-05T22:50:16Z

Guide lines

Tlinnet: /* Guide lines */

2011-12-05T22:48:49Z

Guide lines

@@ Line 4: / Line 4: @@
 #: You can redirect and copy history for a wikipage, by using the '''move''' button. It is located "top right" under the '''arrow''', next to the search box.
 #: Or you can make a redirect, from another page. Write only this in the wiki page:
- <nowiki>#REDIRECT [[scriptname]] </nowiki>
+#: <code><nowiki>#REDIRECT [[scriptname]]</nowiki></code>
 # Function name should in generally not contain big letters. Instead use "underscore".
 #: '''ColorByDisplacementAll''' should instead be named: '''colorbydisplacement_all'''

@@ Line 1: / Line 1: @@
 = Guide lines =
 To make a good PyMOL wiki page, consider these guidelines.
-# Make sure that filename for script and wiki page is small and the same.
+# Filename for script and wiki page name should be [[Git_intro#Naming_convention|lower case and the same]].
 #: You can redirect and copy history for a wikipage, by using the '''move''' button. It is located "top right" under the '''arrow''', next to the search box.
 #: Or you can make a redirect, from another page. Write only this in the wiki page:
-  <nowiki>_#REDIRECT [[scriptname]] </nowiki>          # The "_" should be a space " "
+  <nowiki>#REDIRECT [[scriptname]] </nowiki>
 # Function name should in generally not contain big letters. Instead use "underscore".
 #: '''ColorByDisplacementAll''' should instead be named: '''colorbydisplacement_all'''
@@ Line 33: / Line 33: @@
 === Use of module include ===
 If your code section is very small, and you want to show it directly at the PyMOL wiki page, you can
-fetch the code directly from Github and show it on the Wiki page. [http://www.pymolwiki.org/index.php/Git_include Read more here.]
+fetch the code directly from Github and show it on the Wiki page. [[Git_include|Read more here]].
 === Categories ===
-You also should put you script in a category. See available categories here: http://www.pymolwiki.org/index.php/Category:Script_Library
+You also should put you script in a category. See available categories here: [[:Category:Script_Library]]
 You add your script to a category, by writing these lines in the end of the wiki page. Examples:
@@ Line 44: / Line 44: @@
 = Template for a new page =
 The following sections, can for example be copied to a new page.<br>
-You can find tips for formatting a mediawiki page here: http://www.mediawiki.org/wiki/Help:Formatting
+You can find tips for formatting a mediawiki page here: [http://www.mediawiki.org/wiki/Help:Formatting Help:Formatting]
 == Introduction ==
 A little section about what the script can do, and maybe why it has been developed and under which protein discipline it is particularly useful.<br>
-Make the info box from template
+Make the info box from [[Template:Infobox script-repo]].
 === Functions ===
@@ Line 89: / Line 83: @@
 If you have used a particular article or figure to get inspiration to your script, then make a reference.
-''Title of reference''. Author name. '''Journal name'''. Vol 08/12/2012, p. 54, fig. 5 [http://dx.doi.org/10.1016/0301-0104(89)87019-3  doi:10.1016/0301-0104(89)87019-3]
+* ''Title of reference''. Author name. '''Journal name'''. Vol 08/12/2012, p. 54, fig. 5 [http://dx.doi.org/10.1016/0301-0104(89)87019-3  doi:10.1016/0301-0104(89)87019-3]

@@ Line 85: / Line 85: @@
 ColorByDisplacementAll O5NT, C5NT, super1=resi 26-355, super2=resi 26-355, doColor=t, doAlign=t
 </syntaxhighlight>
 == References ==

@@ Line 45: / Line 45: @@
 The following sections, can for example be copied to a new page.<br>
 You can find tips for formatting a mediawiki page here: http://www.mediawiki.org/wiki/Help:Formatting
 == Introduction ==
-A little section about what the script can do, and maybe why it has been developed and under which protein discipline it is particularly useful.
+A little section about what the script can do, and maybe why it has been developed and under which protein discipline it is particularly useful.<br>
 === Functions ===

@@ Line 4: / Line 4: @@
 #: You can redirect and copy history for a wikipage, by using the '''move''' button. It is located "top right" under the '''arrow''', next to the search box.
 #: Or you can make a redirect, from another page. Write only this in the wiki page:
-  <nowiki>_#REDIRECT [[scriptname]] </nowiki> The "_" should be a space " "
+  <nowiki>_#REDIRECT [[scriptname]] </nowiki>          # The "_" should be a space " "
 # Function name should in generally not contain big letters. Instead use "underscore".
 #: '''ColorByDisplacementAll''' should instead be named: '''colorbydisplacement_all'''

← Older revision	Revision as of 01:47, 28 March 2014
(No difference)

@@ Line 57: / Line 57: @@
 == Example of use ==
 Here you write some example of use. Try to make examples, that anyone can access right away.<br>
 Do this by fetching proteins, and if you need other example files, but them in: '''Pymol-script-repo/files_for_examples'''

@@ Line 3: / Line 3: @@
 # Make sure that filename for script and wiki page is small and the same.
 #: You can redirect and copy history for a wikipage, by using the '''move''' button. It is located "top right" under the '''arrow''', next to the search box.
-#: Or you can make a redirect, from another page. Write only this in the wiki page: <nowiki> #REDIRECT [[colorbydisplacement]] </nowiki>
+#: Or you can make a redirect, from another page. Write only this in the wiki page: <nowiki> #REDIRECT [[scriptname]] </nowiki>
 # Function name should in generally not contain big letters. Instead use "underscore".
 #: '''ColorByDisplacementAll''' should instead be named: '''colorbydisplacement_all'''
@@ Line 9: / Line 9: @@
 # The code reference part should be almost exactly as in the example here in this post.
 # Strongly consider to add figures to your post.
-# Make a description in the top of script by using three primes <nowiki>''' Text </nowiki>
+# Make a description in the top of script by using three primes <nowiki>''' Text '''</nowiki>.
 <syntaxhighlight lang="python">
 '''
 Described at PyMOL wiki:
-http://www.pymolwiki.org/index.php/yourscript
+http://www.pymolwiki.org/index.php/scriptname
 Authors : yourname