[opensuse-xorg] libX11 documentation complaints
1. Chapters in libX11.html are not in TOC. That makes it hard to identify the chapter of a given section. 2. libX11.ps has no index. It should be on page 485 which does not exist. 3. XGContextFromGC is not described in its manual page. 4. libX11.html is one big document, which makes the scroll bar unreliable in TOC 5. Tables in libX11.html are replaced by missing images (e.g. /Window attribute value mask bits/ ) Please fix, Chris -- To unsubscribe, e-mail: opensuse-xorg+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-xorg+help@opensuse.org
* Krzysztof Żelechowski <giecrilj@stegny.2a.pl> [01-17-11 07:22]:
1. Chapters in libX11.html are not in TOC. That makes it hard to identify the chapter of a given section. 2. libX11.ps has no index. It should be on page 485 which does not exist. 3. XGContextFromGC is not described in its manual page. 4. libX11.html is one big document, which makes the scroll bar unreliable in TOC 5. Tables in libX11.html are replaced by missing images (e.g. /Window attribute value mask bits/ )
Please fix,
You do realize you are dealing with *open-source* where no one is responsible, but *everyone* is responsible. You may get lucky and another *interested* individual will take on the task, but you are just a likely to effect a solution by attempting the solution yourself and submitting it for use/approval. Normally document writing is the lowest rung on the ladder and the biggest failing in open-source. Coders speak a different language and as a group are poor documenters as they write what they understand and not what you understand. The items you note may not seem important to the author or may be something he/she believes would be understood. -- Patrick Shanahan Plainfield, Indiana, USA HOG # US1244711 http://wahoo.no-ip.org Photo Album: http://wahoo.no-ip.org/gallery2 Registered Linux User #207535 @ http://counter.li.org -- To unsubscribe, e-mail: opensuse-xorg+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-xorg+help@opensuse.org
Dnia poniedziałek, 17 stycznia 2011 o 14:47:04 Patrick Shanahan napisał(a):
* Krzysztof Żelechowski <giecrilj@stegny.2a.pl> [01-17-11 07:22]:
1. Chapters in libX11.html are not in TOC. That makes it hard to identify the chapter of a given section. 2. libX11.ps has no index. It should be on page 485 which does not exist. 3. XGContextFromGC is not described in its manual page. 4. libX11.html is one big document, which makes the scroll bar unreliable in TOC 5. Tables in libX11.html are replaced by missing images (e.g. /Window attribute value mask bits/ )
Please fix,
You do realize you are dealing with *open-source* where no one is responsible, but *everyone* is responsible.
This is not exactly true because open source projects have managers with write access.
You may get lucky and another *interested* individual will take on the task, but you are just a likely to effect a solution by attempting the solution yourself and submitting it for use/approval.
In short, I do. However, a community-submitted solution requires significantly more work (in terms of process and learning things) compared to the amount of work required of the project manager.
Normally document writing is the lowest rung on the ladder and the biggest failing in open-source. Coders speak a different language and as a group are poor documenters as they write what they understand and not what you understand. The items you note may not seem important to the author or may be something he/she believes would be understood.
Of course. That is why they need to be bothered about such things by the users. (Observe that you can steer out of this dead end by publishing the material on a wiki.) BTW, the documentation available for X11 is generally quite decent. Cheers, Chris -- To unsubscribe, e-mail: opensuse-xorg+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-xorg+help@opensuse.org
On Mon, Jan 17, 2011 at 01:23:14PM +0100, Krzysztof Żelechowski wrote:
1. Chapters in libX11.html are not in TOC. That makes it hard to identify the chapter of a given section.
Apparently this has been fixed in libX11-1.4.0 (openSUSE:Factory or X11:XOrg).
2. libX11.ps has no index. It should be on page 485 which does not exist.
Postscript documentation has been dropped in libX11-1.4.0 (openSUSE:Factory or X11:XOrg).
3. XGContextFromGC is not described in its manual page.
Feel free to report upstream.
4. libX11.html is one big document, which makes the scroll bar unreliable in TOC
libX11 HTML documentation has been splitted into various .html files with libX11-1.4.0 (openSUSE:Factory or X11:XOrg).
5. Tables in libX11.html are replaced by missing images (e.g. /Window attribute value mask bits/ )
Fixed in libX11-1.4.0 (openSUSE:Factory or X11:XOrg). Thanks, Stefan Public Key available ------------------------------------------------------ Stefan Dirsch (Res. & Dev.) SUSE LINUX Products GmbH Tel: 0911-740 53 0 Maxfeldstraße 5 FAX: 0911-740 53 479 D-90409 Nürnberg http://www.suse.de Germany ----------------------------------------------------------------- SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nürnberg) ----------------------------------------------------------------- -- To unsubscribe, e-mail: opensuse-xorg+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-xorg+help@opensuse.org
participants (3)
-
Krzysztof Żelechowski -
Patrick Shanahan -
Stefan Dirsch