[svnbook commit] r3242 - trunk/src/nb
noreply at red-bean.com
Tue Aug 5 00:33:24 CDT 2008
Date: Tue Aug 5 00:33:24 2008
New Revision: 3242
* src/nb/METHOD: Various minor changes.
--- trunk/src/nb/METHOD (original)
+++ trunk/src/nb/METHOD Tue Aug 5 00:33:24 2008
@@ -43,11 +43,10 @@
* Commit mode
- An unique character from the “private use” area in the Unicode table
- (ﳢ, U+FCE2) is inserted between all occurences of double
- dashes in everything that is commented out, i.e. the English text.
- This makes the XML valid and can be checked into the repository or
- be built.
+ An unique character (U+FCE2, also known as ﳢ) is inserted
+ between all occurences of double dashes in everything that is
+ commented out, i.e. the English text. This makes the XML valid and
+ can be checked into the repository or be built.
* Edit mode
All the ﳢs are removed, and the files are now ready for
diffing against the English files or something else. You probably
@@ -56,13 +55,14 @@
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.
+ 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
-there are some double dashes which needs escaping, the make process (you
-always make before checkin, right?) will return errors like
+there are some double dashes which needs escaping, the validation
+process (you always run “make valid” before checkin, right?) will return
book/ch-basic-usage.xml:327: parser error : Comment must not contain
@@ -75,8 +75,8 @@
To translate a paragraph, the English text has to be commented out and
the translation follows immediately after the commented-out block. This
is done with the predefined macro in src/nb/tools/svnbook.vim which
-filters the block through the src/nb/bin/dings_it script. Yeh, oddball
-name, but it works.
+filters the block through the src/nb/bin/dings_it script. Weird name,
+but it works.
Mark the paragraph with Shift-V in Vim and press <F5>. The macro expects
the dings_it script to exist at ~/bin/dings_it, and if it does, the
@@ -173,17 +173,18 @@
# (part of the Vim package) it is fairly easy to copy the changes from
# the English sections to the translated sections.
- # Ensure that all files are ready for commit:
+ # After you’ve done editing the files, ensure that all files are ready
+ # for commit:
# Then, check that nothing in the English parts have changed, i.e. the
- # XML file corresponds to the English copy:
+ # XML file corresponds to the English original:
# Check that the XML doesn’t contain errors:
# If xmllint(1) is not available, make a test build:
- # Update the TRANSLATION-STATUS file
- # make status
+ # Update the TRANSLATION-STATUS file:
+ make status
More information about the svnbook-dev