changeset 496:fb95d70c80d5

More help
author Chris Cannam
date Fri, 19 Aug 2011 16:30:43 +0100
parents e6141a238811
children a9032181c37d
files easyhg.qrc help/a-11.html help/a-12.html help/a-20.html help/a-21.html help/a-22.html help/a-23.html help/generate.sh help/images/openlocal.png help/images/openlocal50.png help/topics.html help/topics/11.txt help/topics/12.txt help/topics/20.txt help/topics/21.txt help/topics/22.txt help/topics/23.txt
diffstat 17 files changed, 211 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/easyhg.qrc	Thu Aug 18 17:13:04 2011 +0100
+++ b/easyhg.qrc	Fri Aug 19 16:30:43 2011 +0100
@@ -29,8 +29,14 @@
 	<file>help/a-04.html</file>
 	<file>help/a-10.html</file>
 	<file>help/a-11.html</file>
+	<file>help/a-12.html</file>
+	<file>help/a-20.html</file>
+	<file>help/a-21.html</file>
+	<file>help/a-22.html</file>
+	<file>help/a-23.html</file>
 	<file>help/images/openremote50.png</file>
 	<file>help/images/openfolder50.png</file>
+	<file>help/images/openlocal50.png</file>
 	<file>easyhg.py</file>
 	<file>easyhg_en.qm</file>
     </qresource>
--- a/help/a-11.html	Thu Aug 18 17:13:04 2011 +0100
+++ b/help/a-11.html	Fri Aug 19 16:30:43 2011 +0100
@@ -5,7 +5,8 @@
 <h2>I have a folder of source code or documents on my computer and I want to use version control to manage it</h2>
 
 <p>To start using version control for a project folder, you need to
-initialise a repository there.  </p>
+initialise a repository there.  EasyMercurial does this for you when
+you open the folder.</p>
 
 <p><b>1. Click the Open toolbar button or use File -> Open</b></p>
 
@@ -13,12 +14,16 @@
 
 <p><b>2. Select &ldquo;File folder&rdquo; as the thing you want to open</b></p>
 
-<p><b>3. Browse to your folder</p>
+<p><b>3. Browse to your folder</b></p>
 
-<p></b>4. Click OK*</p>
+<p><b>4. Click OK</b></p>
 
 <p>A new repository will be created, stowed into the working folder you
-selected.  It will have an empty history, until you add and commit
-some files.
+selected.  At first, it will have an empty history.  You can then
+start to add and commit changes to your files.</p>
+
+<p>(You will need to &ldquo;add&rdquo; files before you can start to track changes to
+them.  The default is for all files in the folder to be treated as
+&ldquo;untracked&rdquo;, i.e. not included in the history.)
 <ul><li>Note: the equivalent Mercurial command for this is <b>hg init</b></li></ul>
 <hr><p><a href="topics.html">Back to Topics</a></p>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/a-12.html	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,19 @@
+<link rel="stylesheet" type="text/css" href="help.css"/>
+<p><a href="topics.html">Back to Topics</a></p><hr>
+
+
+<h2>I have a Mercurial repository on my local computer and I want to use it with EasyMercurial</h2>
+
+<p>Just open it:</p>
+
+<p><b>1. Click the Open toolbar button or use File -> Open</b></p>
+
+<p><center><img src="images/openlocal50.png"></center></p>
+
+<p><b>2. Select &ldquo;Local repository&rdquo; as the thing you want to open</b></p>
+
+<p><b>3. Browse to the working folder for your local repository</b></p>
+
+<p><b>4. Click OK</b></p>
+
+<hr><p><a href="topics.html">Back to Topics</a></p>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/a-20.html	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,32 @@
+<link rel="stylesheet" type="text/css" href="help.css"/>
+<p><a href="topics.html">Back to Topics</a></p><hr>
+
+
+<h2>I've added a new file: what do I do with it?</h2>
+
+<p>When you add a new file in the working folder, you normally want to
+ensure that Mercurial keeps track of changes to that file &ndash; and that
+the file is included in all copies of the repository.  To do this, you
+need to tell Mercurial to <i>track</i> the file by adding it to version
+control.</p>
+
+<p>EasyMercurial shows files that have been created but not added in the
+<b>&ldquo;Untracked&rdquo;</b> file list under &ldquo;My Work&rdquo;.  (If your file is not listed
+there, try clicking the Refresh button.)</p>
+
+<p><b>1. Find the file you want to add in the Untracked list and select it</b></p>
+
+<p><b>2. Click Add in the toolbar on the left of the window</b></p>
+
+<p>The file will be moved to the <b>&ldquo;Added&rdquo;</b> list.  This tells Mercurial to
+track the file.  The next time you commit, the contents of your new
+file will be recorded as part of that change set.
+<ul><li>Note: the equivalent Mercurial command for this is <b>hg add</b></li></ul></p>
+
+<p>Of course, you don't always want to track every file in your working
+copy.  Object files generated by a compiler, output files from tests,
+etc should often not be included in version control.  You can ensure
+that such files don't show up in the Untracked list by right-clicking
+on them and choosing <b>&ldquo;Ignore..."</b>.</p>
+
+<hr><p><a href="topics.html">Back to Topics</a></p>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/a-21.html	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,24 @@
+<link rel="stylesheet" type="text/css" href="help.css"/>
+<p><a href="topics.html">Back to Topics</a></p><hr>
+
+
+<h2>I have changed some files and I want to record the changes</h2>
+
+<p>Click the Commit button in the toolbar on the left to commit all of
+the changes you have made to tracked files in your working folder.
+That is, all files listed as <b>&ldquo;Modified&rdquo;</b>, <b>&ldquo;Removed&rdquo;</b>, or <b>&ldquo;Added&rdquo;</b>
+under &ldquo;My Work&rdquo;.</p>
+
+<p>(If the files you have changed are still listed as <b>&ldquo;Untracked&rdquo;</b>, then
+you must add them before you can commit.  See <a href="a-20.html">I've added a new file...</a>.</p>
+
+<p>When you commit your changes, you will be asked for a commit message
+which will accompany that change set in the history.  Enter something
+that will help you remember &ndash; and other readers understand &ndash; what
+you have changed and why.</p>
+
+<p>If you want to commit only some files, right-click on them in the list
+and choose Commit from the context menu.
+<ul><li>Note: the equivalent Mercurial command for this is <b>hg commit</b></li></ul></p>
+
+<hr><p><a href="topics.html">Back to Topics</a></p>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/a-22.html	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,11 @@
+<link rel="stylesheet" type="text/css" href="help.css"/>
+<p><a href="topics.html">Back to Topics</a></p><hr>
+
+
+<h2>I want to rename or remove a file</h2>
+
+
+
+
+
+<hr><p><a href="topics.html">Back to Topics</a></p>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/a-23.html	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,13 @@
+<link rel="stylesheet" type="text/css" href="help.css"/>
+<p><a href="topics.html">Back to Topics</a></p><hr>
+
+
+<h2>I just renamed or removed a file using the system file manager &ndash; then I remembered I was supposed to do it using the version control tool &ndash; what now?</h2>
+
+
+
+
+
+
+
+<hr><p><a href="topics.html">Back to Topics</a></p>
--- a/help/generate.sh	Thu Aug 18 17:13:04 2011 +0100
+++ b/help/generate.sh	Fri Aug 19 16:30:43 2011 +0100
@@ -21,6 +21,7 @@
 s/^{[\w\s]+}//s;
 s/^(\s*)([A-Za-z][^\n]*)/$1<h2>$2<\/h2>/s;
 s/^\s+\*\s+(.*)$/<ul><li>$1<\/li><\/ul>/gm;
+s/\*([\w"][^\*]+)\*/<b>$1<\/b>/gs;
 s/"([\w])/&ldquo;$1/gs;
 s/([\w])"/$1&rdquo;/gs;
 s/^\#([^\s]+)$/<center><img src="images\/$1.png"><\/center>/gm;
@@ -30,10 +31,9 @@
 s/^\n*(<[^p])/\n<p>$1/gs;
 s/([^\n])\n\n/$1<\/p>\n\n/gs;
 s/([^>\n])\n*$/$1<\/p>\n\n/gs;
-s/\[\[([^\|]*)\|([^\]]*)\]\]/<a href="$1">$2<\/a>/gs;
+s/\[\[([^\|]*)\|([^\]]*)\]\]/<a href="a-$1.html">$2<\/a>/gs;
 s/\[\[([^\|\]]*)\]\]/<a href="$1">$1<\/a>/gs;
 s/\b_([^_]+)_\b/<i>$1<\/i>/gs;
-s/\*(\w[^\*]+)\*/<b>$1<\/b>/gs;
 s/@(\w[^@]+)@/<code>$1<\/code>/gs;
 s/---/&mdash;/gs;
 s/--/&ndash;/gs;
Binary file help/images/openlocal.png has changed
Binary file help/images/openlocal50.png has changed
--- a/help/topics.html	Thu Aug 18 17:13:04 2011 +0100
+++ b/help/topics.html	Fri Aug 19 16:30:43 2011 +0100
@@ -8,3 +8,9 @@
 <h3>Opening and initialising things</h3>
 <p><a href="a-10.html">Someone gave me a repository URL and asked me to clone it</a></p>
 <p><a href="a-11.html">I have a folder of source code or documents on my computer and I want to use version control to manage it</a></p>
+<p><a href="a-12.html">I have a Mercurial repository on my local computer and I want to use it with EasyMercurial</a></p>
+<h3>Making changes</h3>
+<p><a href="a-20.html">I've added a new file: what do I do with it?</a></p>
+<p><a href="a-21.html">I have changed some files and I want to record the changes</a></p>
+<p><a href="a-22.html">I want to rename or remove a file</a></p>
+<p><a href="a-23.html">I just renamed or removed a file using the system file manager &ndash; then I remembered I was supposed to do it using the version control tool &ndash; what now?</a></p>
--- a/help/topics/11.txt	Thu Aug 18 17:13:04 2011 +0100
+++ b/help/topics/11.txt	Fri Aug 19 16:30:43 2011 +0100
@@ -3,7 +3,8 @@
 I have a folder of source code or documents on my computer and I want to use version control to manage it
 
 To start using version control for a project folder, you need to
-initialise a repository there.  
+initialise a repository there.  EasyMercurial does this for you when
+you open the folder.
 
 *1. Click the Open toolbar button or use File -> Open*
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/topics/12.txt	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,16 @@
+{Opening and initialising things}
+
+I have a Mercurial repository on my local computer and I want to use it with EasyMercurial
+
+Just open it:
+
+*1. Click the Open toolbar button or use File -> Open*
+
+#openlocal50
+
+*2. Select "Local repository" as the thing you want to open*
+
+*3. Browse to the working folder for your local repository*
+
+*4. Click OK*
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/topics/20.txt	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,30 @@
+{Making changes}
+
+I've added a new file: what do I do with it?
+
+When you add a new file in the working folder, you normally want to
+ensure that Mercurial keeps track of changes to that file -- and that
+the file is included in all copies of the repository.  To do this, you
+need to tell Mercurial to _track_ the file by adding it to version
+control.
+
+EasyMercurial shows files that have been created but not added in the
+*"Untracked"* file list under "My Work".  (If your file is not listed
+there, try clicking the Refresh button.)
+
+*1. Find the file you want to add in the Untracked list and select it*
+
+*2. Click Add in the toolbar on the left of the window*
+
+The file will be moved to the *"Added"* list.  This tells Mercurial to
+track the file.  The next time you commit, the contents of your new
+file will be recorded as part of that change set.
+
+ * Note: the equivalent Mercurial command for this is *hg add*
+
+Of course, you don't always want to track every file in your working
+copy.  Object files generated by a compiler, output files from tests,
+etc should often not be included in version control.  You can ensure
+that such files don't show up in the Untracked list by right-clicking
+on them and choosing *"Ignore..."*.
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/topics/21.txt	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,22 @@
+{Making changes}
+
+I have changed some files and I want to record the changes
+
+Click the Commit button in the toolbar on the left to commit all of
+the changes you have made to tracked files in your working folder.
+That is, all files listed as *"Modified"*, *"Removed"*, or *"Added"*
+under "My Work".
+
+(If the files you have changed are still listed as *"Untracked"*, then
+you must add them before you can commit.  See [[20|I've added a new file...]].
+
+When you commit your changes, you will be asked for a commit message
+which will accompany that change set in the history.  Enter something
+that will help you remember -- and other readers understand -- what
+you have changed and why.
+
+If you want to commit only some files, right-click on them in the list
+and choose Commit from the context menu.
+
+ * Note: the equivalent Mercurial command for this is *hg commit*
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/topics/22.txt	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,8 @@
+{Making changes}
+
+I want to rename or remove a file
+
+
+
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/topics/23.txt	Fri Aug 19 16:30:43 2011 +0100
@@ -0,0 +1,10 @@
+{Making changes}
+
+I just renamed or removed a file using the system file manager -- then I remembered I was supposed to do it using the version control tool -- what now?
+
+
+
+
+
+
+