Re: User manual modification

Corrected diff attached, addressing all your comments bar one (see below).

Ian

On 2012-03-11, at 10:36 AM, Fabian Keil wrote:

> Ian Silvester <[email protected]> wrote:
> 
>> I've attached a text file containing the git diff of the changes I've
>> made to the user manual with respect to installation on OS X. Could
>> y'all take a look at my changes to see that they're sensible, and could
>> someone who has a working DocBook build environment check that the
>> resultant HTML version looks fine? Once I get the thumbs up on both
>> counts I will commit the change.
> 
> 1)
> It doesn't build:
> 
> fk@mint ~/privoxy $ make dok
> Setting doc version and status to 3.0.20, UNRELEASED
> rm -f -r doc/source/*bak doc/source/*/*bak
> Setting docs to not stable 3.0.20
> rm -f -r doc/source/*bak doc/source/*/*bak;
> rm -f doc/webserver/developer-manual/*.html
> rm -f -r doc/source/developer-manual
> mkdir -p doc/source/developer-manual
> cd doc/source/developer-manual && jade -c /usr/share/sgml/docbook/dtd/3.1/docbook.cat -ihtml -t sgml  -D.. -d ldp.dsl#html ../developer-manual.sgml && cd .. && cp developer-manual/*.html ../webserver/developer-manual/
> rm -f doc/webserver/user-manual/*.html
> rm -f -r doc/source/user-manual/
> mkdir -p doc/source/user-manual
> cd doc/source/user-manual && jade -c /usr/share/sgml/docbook/dtd/3.1/docbook.cat -ihtml -t sgml  -D.. -d ldp.dsl#html -iuser-man ../user-manual.sgml && cd .. && cp user-manual/*.html ../webserver/user-manual/
> jade:../user-manual.sgml:308:28:E: value of attribute "ID" must be a single token
> jade:../user-manual.sgml:337:28:E: value of attribute "ID" must be a single token
> make: *** [dok-user] Error 1
> 
> This can be fixed by replacing the spaces in the ids with dashes.
> 
> 2)
> The patch contains a couple of lines with trailing white-space
> which should be trimmed before it is committed.
> 
> 3)
> There's a line break inside a "have" instead of behind it.
> 
> 4)
> Please remove the "free" in front of "Xcode distribution" or
> replace it with something like "free of charge" or "gratis"
> that is harder to misunderstand.
> 
> 5)
> To me "run ... as sudo from an administrator account" means
> executing sudo after logging into the administrator account.
> 
> Something like "run ... with administrator privileges using sudo"
> would be more clear (to me).

Yes, on a 'normal' *nix system I'd entirely agree with you, but the default sudoers configuration on OS X is to allow only root and admin group accounts to sudo, hence my choice of wording. The first account configured when installing the OS is automatically put in the admin group (for most OS X users this is the only account they'll ever have!) and the only awareness most users have of the groups concept is a tickbox on the User preference pane labelled 'Allow this user to administer this computer'.

Cheers,

Ian

------------------------------------------------------------------------------
Virtualization & Cloud Management Using Capacity Planning
Cloud computing makes use of virtualization - but cloud computing 
also focuses on allowing computing to be delivered as a service.
http://www.accelacomm.com/jaw/sfnl/114/51521223/

_______________________________________________
Ijbswa-developers mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ijbswa-developers