<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta name="robots" content="index,nofollow">



<title>WikiTool - MLton Standard ML Compiler (SML Compiler)</title>
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="all" href="common.css">
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="screen" href="screen.css">
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="print" href="print.css">


<link rel="Start" href="Home">


</head>

<body lang="en" dir="ltr">

<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-833377-1";
urchinTracker();
</script>
<table bgcolor = lightblue cellspacing = 0 style = "border: 0px;" width = 100%>
  <tr>
    <td style = "
		border: 0px;
		color: darkblue; 
		font-size: 150%;
		text-align: left;">
      <a class = mltona href="Home">MLton MLTONWIKIVERSION</a>
    <td style = "
		border: 0px;
		font-size: 150%;
		text-align: center;
		width: 50%;">
      WikiTool
    <td style = "
		border: 0px;
		text-align: right;">
      <table cellspacing = 0 style = "border: 0px">
        <tr style = "vertical-align: middle;">
      </table>
  <tr style = "background-color: white;">
    <td colspan = 3
	style = "
		border: 0px;
		font-size:70%;
		text-align: right;">
      <a href = "Home">Home</a>
      &nbsp;<a href = "Index">Index</a>
      &nbsp;
</table>
<div id="content" lang="en" dir="ltr">
We have written a simple command-line tool that makes it possible to edit wiki pages using your favorite text editor instead of within a browser text box.  The tool provides a CVS/SVN-like command-line interface that can be used to update local copies of files from the web and to commit local modifications to the web. <p>
The tool is written in SML (of course) and is available in the MLton <a href="Sources">Sources</a> (<a href = "http://mlton.org/cgi-bin/viewsvn.cgi/tools/wiki"><img src="moin-www.png" alt="[WWW]" height="11" width="11">wiki</a>).  To compile it, you need to have the latest SVN of the MLton library sources, and point the MLB path variable <tt>MLTON_SRC_LIB</tt> at the <tt>lib/mlton</tt> dir in the sources. 
</p>
<p>
Here's a quick tutorial on how to use the tool 
</p>

    <ol type="1">

    <li>
<p>
Create a new directory for your local copy of the wiki files. 
</p>
</li>
    <li class="gap">
<p>
In that directory, login.  
<pre> wiki login http://mlton.org StephenWeeks &lt;my password&gt;</pre>
</p>
</li>
    <li class="gap">
<p>
Checkout (the raw wiki markup) files with commands like:  
<pre> wiki checkout Home
 wiki checkout Index Documentation</pre>
</p>
</li>
    <li class="gap">
<p>
Edit the files using your favorite text editor.  
</p>
</li>
    <li class="gap">
<p>
Commit your changes with a command like   
<pre> wiki commit UserGuide</pre>
</p>
</li>
    <li class="gap">
<p>
Logout.  
<pre> wiki logout</pre>
</p>
</li>

    </ol>


<p>
That's it for the simple use.  There are also other commands like CVS/SVN. 
</p>

    <ul>

    <li>
<p>
 Download the new version of a file from the web if there is one.  
<pre> wiki update UserGuide</pre>
</p>
</li>
    <li class="gap">
<p>
 Schedule a new file to be added (must be later committed, just like  CVS/SVN) .  
<pre> wiki add NewFile</pre>
</p>
</li>
    <li class="gap">
<p>
 Rename a page  
<pre> wiki rename OldFile NewFile</pre>
</p>
</li>
    <li class="gap">
<p>
 Remove a page  
<pre> wiki remove DeletedFile</pre>
</p>
</li>
    <li class="gap">
<p>
 Attach files to a page  
<pre> wiki attach &lt;file&gt; &lt;attachment&gt;</pre>
</p>
</li>
    <li class="gap">
<p>
 Detach files to a page  
<pre> wiki detach &lt;file&gt; &lt;attachment&gt;</pre>
</p>
</li>

    </ul>


<p>
<tt>rename</tt> and <tt>remove</tt> shouldn't work for most people on <tt>mlton.org</tt> because of the way our <a href="AccessControl">AccessControl</a> is set up. 
</p>
<p>
This code is a two-day hack and is not widely used.  But we've found it useful.  Please send bug reports to <a class="external" href="mailto:MLton@mlton.org"><img src="moin-email.png" alt="[MAILTO]" height="10" width="14">MLton@mlton.org</a>. 
</p>
</div>



<p>
<hr>
Last edited on 2007-08-13 18:33:50 by <span title="c-71-57-91-146.hsd1.il.comcast.net"><a href="MatthewFluet">MatthewFluet</a></span>.
</body></html>
