List Info

Thread: Goofs in the docs




Goofs in the docs
user name
2006-12-16 08:59:31
[A complimentary Cc of this posting was sent to

<omicronpersei8imagemagick.org>], who wrote in article
<200612150335.kBF3ZiU6027764studio.imagemagick.org>:
> > a) The web look-and-feel:
> > 
> >        0) Tries to open everything in a new
window.  Is there at least
> >           ONE person who finds this beneficial? 
 :-(
> 
> In general we only open a new window if it is external
content.

Did you try?  Go to "Processing", and look for
links there...

> With tabbed windows under Firefox 1.8 it flows well.

*Forcing* something on user never works well.  Opening a
thing in a
tab should be the reader's decision, not writer's.  Thanks,
but I know
how to mid-click...

> > 	  Some time passes; you want to find this
"in depth" page
> > 	  again - and it is very hard to do it.  One
either needs to
> > 	  sift through browser history window, or go
through the
> > 	  sitemap (which, in turn, is not very prominent
on the title
> > 	  page).
> 
> We've expanded the site map.  If all else fails, use
the search engine at
> 
>   http:
//magick.imagemagick.org/script/search.php

And search for *what*?

It is *great* that in-depth reference pages are available. 
It hurts
that they are not readily available through the navigation
pane on the
left.

As done now, this pane takes about 25% of (very valuable)
screen real
estate, and does not provide a lot of functionality.  Why
not make it
into a top-bar, instead of a left-bar?  Then it would not
eat any real
estate...

> >        3) My version is 6.2.8-3; it took a lot of
time to realize that
> >           the bugs I see are just for things which
are new in 6.3.4
> >           (or whatever is the version documented
on the main page).
> >           Due to this (obvious in hindsight)
confusion, would not it
> >           be better to have "newer
stuff" marked as <new in 6.3.1> or
> >           somesuch?

> Classic software conundrum.  All bugs are fixed in the
next release.

I'm not sure that you understood my complaint.  With web
docs, it is
important to have a way to sync the docs on the server with
the
version of software the users have on their clients.  E.g.,
one way to
do it is to have a tiny clock icon near a new feature with a
tooltip
stating the version this feature was implemented.  (Or just
keep
option lists separate for all released versions.)

> >        4) When in Firefox, the
command-line-options page acquires
> >           horizontal scrollbar (even with quite
wide a screen).  Is it
> >           a Firefox bug (1.5.* here), or an
indication of a misfeature
> >           with the page?

> We follow most web standards except we use tables for
layout instead of
> CSS but we're working on that.  Perhaps its a bug in
your browser.

My FF is the latest pre-2.0 release.  I'm sure it is the
most used
version in existence.  Do you see the horizontal scrollbar
on your setup?

> >    -fx docs specify some mysterious %[fx:] and
%[pixel:] which are not
> >     mentioned again in these sections.  It took me
several days to
> >     realize that these escapes related not to -fx,
but to -format
> >     (right?).  I think this should be amended.

> We're aware of deficiencies in the documentation. 
We're working on it as
> time permits.

I do not follow: are you interested in having *particular*
complaints
about the docs?

> >    -blur and -gaussian - are they the same, or
different?  What is the
> >     mysterious "radius and standard deviation
(sigma)" they mention?
> >     Assuming some sanity, -gaussian should take
X_SEMIAXIS x
> >     Y_SEMIAXIS arguments.  Does it?

> Radius and deviation determines the shape of the
convolution filter.

  "Option -matte determines how the program
works."

Do you see the similarity?  

> We'll expand on this subject when time permits.

Could you do it now, please?  I expect that the convolution
filter in
the case of -gaussian is some cut-off of the centered
gaussian
distribution.  A (centered) Gaussian distribution has 3
parameters
(sigmaIJ with IJ in 11, 12, 22); a "radius and standard
deviation
(sigma)" has no obvious map to these parameters...

Or is it that "standard deviation" determines the
sigma11=sigma22,
sigma12=0, and "radius" determines the used
cut-off?  Then I do not see
how one could be able to specify radius, and not sigma...

Thanks,
Ilya

_______________________________________________
Magick-bugs mailing list
Magick-bugsimagemagick.org
http://studio.imagemagick.org/mailman/listinfo/magick-
bugs
[1]

about | contact  Other archives ( Real Estate discussion Medical topics )