[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Book: split up compound words

From: C. Michael Pilato <cmpilato_at_collab.net>
Date: 2004-10-21 21:11:22 CEST

Julian Foad <julianfoad@btopenworld.com> writes:

> What do the book authors think of this? (I know people will say, "But
> I think of logfile as a single word.")
>
> - Julian
> Book: expand some jargon compound words.
>
> Writing a jargon phrase such as "dump file" as a compound word
> ("dumpfile") is common among those who use it often, but
> inappropriate in text aimed at a wide audience.

I agree with the principle of this change, but a simple string
substitution is causing me a little grief in some places.

> Index: doc/book/book/ch05.xml
> ===================================================================
> --- doc/book/book/ch05.xml (revision 11526)
> +++ doc/book/book/ch05.xml (working copy)
> @@ -1327,14 +1327,14 @@
> aren't careless about it, you can manually inspect and
> modify it. Of course, the downside is that if you have two
> years' worth of repository activity encapsulated in what is
> - likely to be a very large dumpfile, it could take you a
> + likely to be a very large dump file, it could take you a
> long, long time to manually inspect and modify it.</para>
>
> <para>While it won't be the most commonly used tool at the
> administrator's disposal, <command>svndumpfilter</command>
> provides a very particular brand of useful
> functionality&mdash;the ability to quickly and easily modify
> - that dumpfile data by acting as a path-based filter. Simply
> + that dump file data by acting as a path-based filter. Simply

This should just read "that dump data".

> @@ -1411,7 +1411,7 @@
> </screen>
>
> <para>To get these three projects into their own repositories,
> - we first make a dumpfile of the whole repository:</para>
> + we first make a dump file of the whole repository:</para>

"we first dump the whole repository:..."

> Index: doc/book/book/appa.xml
> ===================================================================
> --- doc/book/book/appa.xml (revision 11523)
> +++ doc/book/book/appa.xml (working copy)
> @@ -6,7 +6,7 @@
> <para>This appendix is a guide for CVS users new to Subversion.
> It's essentially a list of differences between the two systems
> as <quote>viewed from 10,000 feet</quote>. For each section, we
> - provide backreferences to relevant chapters when
> + provide back-references to relevant chapters when
> possible.</para>

The correct form of this particular compound word lacks the hyphen.
But I'm not fond of the sentence at all. How about:

   "When other locations in this book contain relevant detailed
    information, sections will refer to those locations."

Or something of the sort.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Oct 21 21:14:04 2004

This is an archived mail posted to the Subversion Dev mailing list.