[interchange-docs] xmldocs - docelic modified 2 files

Stefan Hornburg racke at linuxia.de
Tue Nov 7 04:27:48 EST 2006


docs at icdevgroup.org wrote:
> User:      docelic
> Date:      2006-11-06 22:14:56 GMT
> Modified:  refs     NoSearch RunDir
> Log:
> * Added example for NoSearch
> * Updated RunDir page
> 
> Revision  Changes    Path
> 1.3       +9 -0      xmldocs/refs/NoSearch
> 
> 
> rev 1.3, prev_rev 1.2
> Index: NoSearch
> ===================================================================
> RCS file: /var/cvs/xmldocs/refs/NoSearch,v
> retrieving revision 1.2
> retrieving revision 1.3
> diff -u -r1.2 -r1.3
> --- NoSearch	6 Nov 2006 18:41:20 -0000	1.2
> +++ NoSearch	6 Nov 2006 22:14:55 -0000	1.3
> @@ -34,3 +34,12 @@
>  </programlisting>
>  __END__
>  
> +__NAME__ example: Overriding __FILENAME__ setting on a specific page
> +<programlisting><![CDATA[
> +[calc] $Config->{NoSearch} = '' [/calc]
> +]]></programlisting>
> +For a discussion on why this example works (and works per-page), see
> +&glos-configuration; glossary entry.
> +__END__
> +
> +
> 
> 
> 
> 1.2       +20 -3     xmldocs/refs/RunDir
> 
> 
> rev 1.2, prev_rev 1.1
> Index: RunDir
> ===================================================================
> RCS file: /var/cvs/xmldocs/refs/RunDir,v
> retrieving revision 1.1
> retrieving revision 1.2
> diff -u -r1.1 -r1.2
> --- RunDir	6 Nov 2006 19:49:24 -0000	1.1
> +++ RunDir	6 Nov 2006 22:14:55 -0000	1.2
> @@ -1,9 +1,26 @@
>  __NAME__ purpose
> -specify directory for runtime files
> +specify directory containing runtime files
>  __END__

I object to the term "containing". It is the defined location _for_ 
runtime files, but doesn't necessarily contain any files.

>  
> +
>  __NAME__ synopsis
> -<arg choice='plain'><replaceable>directory</replaceable></arg>
> +<arg choice='plain'><replaceable>directory_name</replaceable></arg>
> +__END__
> +
> +
> +__NAME__ description
> +Specify the directory containing "runtime" information.
> +</para><para>
> +This directory is similar to <filename class='directory'>/var/run/</filename>
> +in the Unix filesystem. Examples of files that you will encounter in there
> +are the global <filename>.structure</filename> file (see
> +&conf-DumpStructure;), <filename>.pid</filename> and
> +<filename>mode.</filename> files and &IC; cronjob files (see &conf-Jobs;).
> +__END__

This is confusing unless you explicitly tell the reader that this 
description refers to the global directive.

Bye
	Racke



-- 
LinuXia Systems => http://www.linuxia.de/
Expert Interchange Consulting and System Administration
ICDEVGROUP => http://www.icdevgroup.org/
Interchange Development Team



More information about the docs mailing list