Re: doc/fvwm/description.xml edits

2014-04-07 Thread Dan.Espen
Stephen Dennison stephe...@gmail.com writes:

 While changing  stuff I noticed  that sometimes an fvwmref  element is
 used around reserved  words and other times it's not.  What's the rule
 for when to use an fvwmref and  when not? Also, should these files use
 no more than 79  columns per line? I saw a note  about that for source
 code in CONVENTIONS after making my edits.

Consistency is great.
I believe the fvwmref elements are there to generate links in the
html version.  Providing there's a target for the link, there should
be an fvwmref.

I think the 79 columns rule is there so we don't see wrap around while
editing.  So short lines are preferable.

 While  looking for  instructions on  how to  contribute, I  noticed an
 issue   with  the   web   site.  However   the
 http://fvwm.org/documentation/faq/ is  generated, under the  answer in
 section 5.2 there is a link  to dev_cvs.php that includes the trailing
 period of the sentence and makes it a broken link.

 Also under 5.2, there are references to doc/DEVELOPERS and
 doc/CONVENTIONS but 
 it appears that these files actually exist under docs.

 The instructions in  the CONVENTIONS file appear to be  out of date or
 maybe  just incomplete,  it refers  to fvwm/fvwm.1.in  for details  on
 formatting but this file doesn't appear to exist anymore.

Will look myself or you could submit a patch.
The cvs package is fvwm-web.


-- 
Dan Espen



doc/fvwm/description.xml edits

2014-04-05 Thread Stephen Dennison
I noticed a grammatical error at the beginning of the man page so I started
poking around the web site to figure out how to contribute.  In accordance
with
FAQ 5.1, I've fetched the latest release and made my (very minor
documentation)
changes.

In accordance with FAQ 5.2, I've updated the ChangeLog file and created a
patch
(attached).

Initially I was going to delete an extra comma, but once I had the document
in
front of me I noticed a few other minor things that I've also fixed.

While changing stuff I noticed that sometimes an fvwmref element is used
around
reserved words and other times it's not.  What's the rule for when to use an
fvwmref and when not?  Also, should these files use no more than 79 columns
per
line?  I saw a note about that for source code in CONVENTIONS after making
my
edits.

While looking for instructions on how to contribute, I noticed an issue
with the web site.  However the http://fvwm.org/documentation/faq/ is
generated, under the answer in section 5.2 there is a link to dev_cvs.php
that
includes the trailing period of the sentence and makes it a broken link.

Also under 5.2, there are references to doc/DEVELOPERS and doc/CONVENTIONS
but
it appears that these files actually exist under docs.

The instructions in the CONVENTIONS file appear to be out of date or maybe
just
incomplete, it refers to fvwm/fvwm.1.in for details on formatting but this
file doesn't appear to exist anymore.
? minor-doc-edits.patch
Index: ChangeLog
===
RCS file: /home/cvs/fvwm/fvwm/ChangeLog,v
retrieving revision 1.3151
diff -u -u -r1.3151 ChangeLog
--- ChangeLog	14 Apr 2013 08:39:09 -	1.3151
+++ ChangeLog	6 Apr 2014 00:44:35 -
@@ -1,3 +1,7 @@
+2014-04-05 Stephen Dennison stephenrd(at)gmail(dot)com
+	* doc/fvwm/description.xml:
+	fixed minor grammatical errors
+
 2013-04-14  Dominik Vogt  dominik(dot)vogt(at)gmx(dot)de
 
 	* libs/fsm.c (CompletNewConnectionMsg, FreeAuthenticationData)
Index: doc/fvwm/description.xml
===
RCS file: /home/cvs/fvwm/fvwm/doc/fvwm/description.xml,v
retrieving revision 1.1
diff -u -u -r1.1 description.xml
--- doc/fvwm/description.xml	10 Mar 2007 05:15:34 -	1.1
+++ doc/fvwm/description.xml	6 Apr 2014 00:44:36 -
@@ -22,7 +22,7 @@
 feel. Since then, fvwm has been greatly enhanced and practically
 all fvwm95 features can be achieved by fvwm./para
 
-paraFvwm provides both, a large
+paraFvwm provides both a large
 emphasis remap='I'virtual desktop/emphasis
 and
 emphasis remap='I'multiple disjoint desktops/emphasis
@@ -35,16 +35,16 @@
 
 paraFvwm provides
 emphasis remap='I'keyboard accelerators/emphasis
-which allow you to perform most window manager functions,
-including moving and resizing windows, and operating the menus,
+that allow you to perform most window manager functions,
+including moving and resizing windows and operating the menus,
 using keyboard shortcuts./para
 
 paraFvwm has also overcome the distinction between configuration
 commands and action commands that most window managers
 make. Configuration commands typically set fonts, colors, menu
-contents, key and mouse function bindings, while action commands
+contents, and key and mouse function bindings, while action commands
 do things like raise and lower windows.  Fvwm makes no such
-distinction, and allows anything to be changed at any time./para
+distinction and allows anything to be changed at any time./para
 
 paraOther noteworthy differences between fvwm and other X11 window
 managers are the introduction of the fvwmref cmd=Style opt=SloppyFocus/ and fvwmref cmd=Style opt=NeverFocus/