How to Edit this Manual...: Difference between revisions
From Knot Atlas
Jump to navigationJump to search
m (Reverted edit of 88.246.49.249, changed back to last version by Drorbn) |
No edit summary |
||
| Line 1: | Line 1: | ||
hacked by i-landet & aman_adanali |
|||
{{Manual TOC Sidebar}} |
|||
To a large extent, editing this manual is easy --- just as easy as editing a page at [http://en.wikipedia.org Wikipedia], or any other wiki. There's some good help on that available at [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page Wikipedia:How to edit a page]. However, because we also use Mathematica code within the manual, and automatically generate the output, there are a few things you need to be aware of. Read on! (or don't -- just go edit!) |
|||
=== The Basic Rules === |
|||
Knot Atlas manual pages are editable and are edited by both humans and robots (dedicated computer programs). Both sides have to be careful not to step into each other's territory. Under the current treaties, robots are responsible for simulated [http://www.wolfram.com Mathematica] output and for certain numerical values that are computed by <code>KnotTheory`</code>. Their territory always lies between {{Robots Left Delimiter}} and {{Robots Right Delimiter}} tags. Humans are responsible for everything else, including brief ventures into the robot's territories to tell the robots what to do. |
|||
=== Human Edits === |
|||
To perform a human edit, simply click on the "edit" link at the top of any manual page (or indeed, at the top of almost any other wiki page) and begin editing, saving your work at the end. Be careful not to modify anything in the robots' territory, delimited by {{Robots Left Delimiter}} and {{Robots Right Delimiter}} tags. |
|||
You may find the [[Local Clip Art]] library useful, or this brief description of [[math mode]]. |
|||
If you're adding a new manual page, start it with "<tt><nowiki>{{Manual TOC Sidebar}}</nowiki></tt>" (this produces the table of contents (TOC) sidebar on the right) and make sure to add your page to the table of contents at [[Manual Table of Contents]] and to the [[Printable Manual]] list-of-sections. |
|||
If you are only interested in an edit confined to a human territory, you don't need to read any further. |
|||
=== What Robots Do === |
|||
Before a human can tell a robot what to do, (s)he must understand the simple way in which robots work. Robots do just one simple thing, and only when instructed to it. Here's how they work: |
|||
#They search the text of a manual page for patterns of the form {{Robots Left Delimiter}}''robot instructions''{{Robots Mid Delimiter}}''old robotic response''{{Robots Right Delimiter}}. |
|||
#They study the ''robot instructions'' and compute something. |
|||
#They print the output, i.e. the ''new robotic response'', in place of the ''old robotic response''. Just to be sure that humans don't modify the ''new robotic response'', robots precede it with a short ''human do not enter'' phrase. [[USER:drorbn|Dror]]'s robot's favourite is '''<!--$StringTake[RobotsWarningPhrase[], {5,-4}]$--><!--Robot Land, no human edits to "END"-->Robot Land, no human edits to "END"<!--END-->'''. |
|||
#Robots never modify their own instructions or venture to human territories. |
|||
=== Human Ventures into Robot Lands === |
|||
It is not a good idea for a human to modify a ''robotic response'', as these changes will be overwritten the next time a robot roams the page. (On the other hand, it doesn't break anything in the meantime.) Better, humans can control the robots. |
|||
* To create a new robot territory, put the pattern {{Robots Left Delimiter}}''robot instructions''{{Robots Mid Delimiter}}{{Robots Right Delimiter}} in the desired place. <font color="red">Note:</font> You must put in {{Robots Right Delimiter}} by hand! The next time a robot visits it will follow the instructions and place its response between the {{Robots Mid Delimiter}} and {{Robots Right Delimiter}} tags. |
|||
* To remove an existing robot territory, simply remove everything from the {{Robots Left Delimiter}} tag to the {{Robots Right Delimiter}}. |
|||
* To modify an existing robot territory, change the content of the ''robot instructions'', between the {{Robots Left Delimiter}} tag and the {{Robots Mid Delimiter}} tag. The next time a robot visits it will follow the new instructions. |
|||
=== Giving Robots Instructions === |
|||
Currently robots understand the following kinds of instructions: |
|||
{| align=center border=1 |
|||
|- valign=top |
|||
! {{Robots Left Delimiter}}''instructions''{{Robots Mid Delimiter}} |
|||
! Description |
|||
! Example |
|||
! Formatted Output |
|||
|- valign=top |
|||
| {{Robots Left Delimiter}}<tt>$<< KnotTheory`$</tt>{{Robots Mid Delimiter}} |
|||
| Simulate <font color=blue><tt><nowiki>In[1]</nowiki></tt></font> of a <code>KnotTheory`</code> session. |
|||
| {{Robots Left Delimiter}}<tt>$<< KnotTheory`$</tt>{{Robots Mid Delimiter}} {{Robots Right Delimiter}} |
|||
| <!--$$<< KnotTheory`$$--> |
|||
<!--Robot Land, no human edits to "END"--> |
|||
<tt><font color=blue>In[1]:=</font></tt><code> << KnotTheory`</code> |
|||
<tt>Loading KnotTheory` (version of August 28, 2005, 22:58:49)...</tt> |
|||
<!--END--> |
|||
|- valign=top |
|||
| {{Robots Left Delimiter}}<tt>$</tt>''Input line''<tt>$</tt>{{Robots Mid Delimiter}} |
|||
| Simulate a Mathematica "<font color=blue><tt><nowiki>In Out</nowiki></tt></font>" pair. |
|||
| {{Robots Left Delimiter}}<tt>$Jones[Knot[3, 1]][q]$</tt>{{Robots Mid Delimiter}} {{Robots Right Delimiter}} |
|||
| <!--$$Jones[Knot[3, 1]][q]$$--> |
|||
<!--Robot Land, no human edits to "END"--> |
|||
{{InOut| |
|||
n = 2 | |
|||
in = <nowiki>Jones[Knot[3, 1]][q]</nowiki> | |
|||
out= <nowiki> -4 -3 1 |
|||
-q + q + - |
|||
q</nowiki>}} |
|||
<!--END--> |
|||
|- valign=top |
|||
| |
|||
| (if output is <code>Null</code>) |
|||
| {{Robots Left Delimiter}}<tt>$Jones[Knot[4, 1]][q];$</tt>{{Robots Mid Delimiter}} {{Robots Right Delimiter}} |
|||
| <!--$$Jones[Knot[4, 1]][q];$$--> |
|||
<!--Robot Land, no human edits to "END"--> |
|||
{{In| |
|||
n = 3 | |
|||
in = <nowiki>Jones[Knot[4, 1]][q];</nowiki>}} |
|||
<!--END--> |
|||
|- valign=top |
|||
| |
|||
| (if graphics) |
|||
| {{Robots Left Delimiter}}<tt>$Show[DrawPD[Knot[5, 1]]]$</tt>{{Robots Mid Delimiter}} {{Robots Right Delimiter}} |
|||
| <!--$$Show[DrawPD[Knot[5, 1]]]$$--> |
|||
<!--Robot Land, no human edits to "END"--> |
|||
{{Graphics| |
|||
n = 5 | |
|||
in = <nowiki>Show[DrawPD[Knot[5, 1]]]</nowiki> | |
|||
img= How_to_Edit_this_Manual..._Out_4.gif | |
|||
out= <nowiki>-Graphics-</nowiki>}} |
|||
<!--END--> |
|||
|- valign=top |
|||
| {{Robots Left Delimiter}}<tt>$?</tt>''Symbol''<tt>$</tt>{{Robots Mid Delimiter}} |
|||
| Simulate a Mathematica help line. |
|||
| {{Robots Left Delimiter}}<tt>?Jones</tt>{{Robots Mid Delimiter}} {{Robots Right Delimiter}} |
|||
| <!--$$?Jones$$--> |
|||
<!--Robot Land, no human edits to "END"--> |
|||
{{HelpLine| |
|||
n = 6 | |
|||
in = <nowiki>Jones</nowiki> | |
|||
out= <nowiki>Jones[L][q] computes the Jones polynomial of a knot or link L as a function of the variable q.</nowiki>}} |
|||
<!--END--> |
|||
|- valign=top |
|||
| |
|||
| (if ''Symbol''<tt>::about</tt> exists) |
|||
| {{Robots Left Delimiter}}<tt>$?Kauffman$</tt>{{Robots Mid Delimiter}} {{Robots Right Delimiter}} |
|||
| <!--$$?Kauffman$$--> |
|||
<!--Robot Land, no human edits to "END"--> |
|||
{{HelpAndAbout| |
|||
n = 7 | |
|||
n1 = 8 | |
|||
in = <nowiki>Kauffman</nowiki> | |
|||
out= <nowiki>Kauffman[K][a, z] computes the Kauffman polynomial of a knot or link K, in the variables a and z.</nowiki> | |
|||
about= <nowiki>The Kauffman program was written by Scott Morrison.</nowiki>}} |
|||
<!--END--> |
|||
|- valign=top |
|||
| {{Robots Left Delimiter}}''inlined command''{{Robots Mid Delimiter}} |
|||
| Perform a Mathematica command "in line". |
|||
| There are {{Robots Left Delimiter}}<tt>NumberOfKnots[10]</tt>{{Robots Mid Delimiter}} {{Robots Right Delimiter}} knots with 10 crossings. |
|||
| There are <!--$NumberOfKnots[10]$--><!--Robot Land, no human edits to "END"-->165<!--END--> knots with 10 crossings. |
|||
|} |
|||
=== Calling for Robotic Action === |
|||
Copy Dror's robot [[Media:ManualSpliceRobot.nb|ManualSpliceRobot.nb]] ([[Image:ManualSpliceRobot.nb|file description]]) to your own computer (it is now yours). The robot is a Mathematica notesbook; simply open it and follow the instructions within. You must have the package [[Setup|<code>KnotTheory`</code>]] around, Scott's Mathematica [[WikiLink - The Mediawiki Interface|WikiLink]] package and java (which comes bundled with Mathematica 4.2 and up). You will need to specify a few paths and your (or better, your robot's) Username and Password on the Knot Atlas wiki. Good luck! |
|||
=== Teaching Robots New Tricks === |
|||
At the moment robots do not ignore their instructions even if they don't understand them, so there can be only one robot master teaching robots what to do, or else chaos may ensue. If you want to build a better robot or extend [[USER:drorbn|Dror]]'s, do it in your sandbox but don't let it roam on public pages. When the new or extended robot is fully trained, and provided its actions extends Dror's robot, send it to Dror and he will upgrade his robot and make the new robot public. |
|||
Revision as of 05:54, 21 April 2007
hacked by i-landet & aman_adanali
