[svnbook commit] r1561 - trunk/src/nb

sunny256 svnbook-dev at red-bean.com
Thu Jul 21 13:07:19 CDT 2005


Author: sunny256
Date: Thu Jul 21 13:07:18 2005
New Revision: 1561

Modified:
   trunk/src/nb/METHOD
Log:
Edit the Norwegian documentation a bit.

* src/nb/METHOD: Various changes.


Modified: trunk/src/nb/METHOD
==============================================================================
--- trunk/src/nb/METHOD	(original)
+++ trunk/src/nb/METHOD	Thu Jul 21 13:07:18 2005
@@ -52,10 +52,12 @@
     All the ﳢs are removed, and the files are now ready for 
     diffing against the English files or something else. You probably 
     won’t need to run this command unless you have to resolve conflicts 
-    or check that nothing have changed in the English sections. This 
-    mode is only for editing purposes, and the files must not be checked 
-    in while in this mode. Run a “make commitmode” to get all files in 
-    shape first.
+    or check that nothing have changed in the English sections. It can 
+    also be practical to use if you have to copy+paste examples or text 
+    with lots of double dashes. Just exit your editor, run "make 
+    editmode" and continue editing. This mode is only for editing 
+    purposes, and the files must not be checked in while in this mode. 
+    Run a “make commitmode” to get all files in shape first.
 
 Normally you don’t have to think about running these make commands, 
 except when you’ve translated text that contains double hyphens. If 
@@ -94,7 +96,7 @@
     actual text when commenting out the original text, not block-level 
     elements.
   * To make reformatting cleaner and to avoid cluttering the diffs with 
-    large sections of wordwrapping, all the translations uses “flowed 
+    large sections of wordwrapping, the whole translation uses “flowed 
     text” (wrapped lines are terminated by a space) and every sentence 
     is written on a new line. This limits wordwrapping to the current 
     sentence only and doesn’t mess up the whole paragraph.
@@ -130,18 +132,24 @@
 incomplete. To make the process of synchronising the translated version 
 with the English version as safe and easy as possible, Subversion itself 
 is merging new changes from the src/en/ directory structure into the 
-src/nb/ area. This is taken care of by “make sync”. The make process 
-merges in new changes since the last make sync into the English sections 
-in the files, and you can then copy the exact changes into the 
-translated sections. Using a visual diff tool in these circumstances is 
-a great help.
+src/nb/ area. This is taken care of by "make sync". This make process 
+does the following things:
+
+  1. sets all the files into edit mode (removes the ﳢs) to 
+     minimise the chance of conflicts,
+  2. merges the changes since the last synchronisation into the 
+     translation from the English version, and
+  3. sets all files back to commit mode.
+
+You can then copy the exact changes into the translated sections. Using 
+a visual diff tool in these circumstances is a great help.
 
 To avoid unnecessary conflicts, it is very important that the English 
-text remain unchanged. Don’t remove or add whitespace, new content is 
-_added_ to the file, it is not _replacing_ something. Use those @ENGLISH 
-markers. If this is done properly, syncronising against the English 
-version is quite easy and seldom produces conflicts. An example of an 
-sync session goes as follows:
+text remain unchanged. Don’t remove or add whitespace, for example. New 
+content is _added_ to the file, it is not _replacing_ something. Use 
+those @ENGLISH markers. If this is done properly, syncronising against 
+the English version is quite easy and seldom produces conflicts. An 
+example of a sync session goes as follows:
 
   cd src/nb/
   make sync
@@ -223,4 +231,5 @@
     files, useful if the XML source is going to be distributed and 
     duplication of the English text is not a good thing.
 
-vim: set fo=tcq2w tw=72 fenc=utf8 ts=2 sw=2 sts=2 com=b\:#,fb\:-,fb\:*,n\:> et :
+vim: set fo=tcq2w tw=72 fenc=utf8 ts=2 sw=2 sts=2 et :
+vim: set com=b\:#,fb\:-,fb\:*,n\:> :



More information about the svnbook-dev mailing list