From owner-freebsd-bugbusters@FreeBSD.ORG Fri Nov 25 04:38:04 2005 Return-Path: X-Original-To: bugbusters@freebsd.org Delivered-To: freebsd-bugbusters@FreeBSD.ORG Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 7C5A916A420 for ; Fri, 25 Nov 2005 04:38:04 +0000 (GMT) (envelope-from keramida@freebsd.org) Received: from nic.ach.sch.gr (nic.sch.gr [194.63.238.4]) by mx1.FreeBSD.org (Postfix) with ESMTP id 0F3FD43D5C for ; Fri, 25 Nov 2005 04:38:01 +0000 (GMT) (envelope-from keramida@freebsd.org) Received: (qmail 3797 invoked by uid 207); 25 Nov 2005 04:38:00 -0000 Received: from keramida@freebsd.org by nic by uid 201 with qmail-scanner-1.21 (sophie: 3.04/2.30/3.97. Clear:RC:1(81.186.70.125):. Processed in 0.867396 secs); 25 Nov 2005 04:38:00 -0000 Received: from dialup125.ach.sch.gr (HELO flame.pc) ([81.186.70.125]) (envelope-sender ) by nic.sch.gr (qmail-ldap-1.03) with AES256-SHA encrypted SMTP for ; 25 Nov 2005 04:37:59 -0000 Received: from flame.pc (flame [127.0.0.1]) by flame.pc (8.13.4/8.13.4) with ESMTP id jAP4bRhY095271; Fri, 25 Nov 2005 06:37:27 +0200 (EET) (envelope-from keramida@freebsd.org) Received: (from keramida@localhost) by flame.pc (8.13.4/8.13.4/Submit) id jAP4bR9r095262; Fri, 25 Nov 2005 06:37:27 +0200 (EET) (envelope-from keramida@freebsd.org) Date: Fri, 25 Nov 2005 06:37:27 +0200 From: Giorgos Keramidas To: Tjabo Kloppenburg Message-ID: <20051125043727.GA82772@flame.pc> References: <200511240725.21826.tklopp@taponet.de> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <200511240725.21826.tklopp@taponet.de> Cc: bugbusters@freebsd.org Subject: Re: docs improvement request X-BeenThere: freebsd-bugbusters@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Coordination of the Problem Report handling effort." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 25 Nov 2005 04:38:04 -0000 On 2005-11-24 07:25, Tjabo Kloppenburg wrote: > hi, > > your bug submit form is broken. > > Let me send you this change-request by email: > > ------------------------------------ > hi, > > Sorry for my bad english. > > I want to suggest a change in the in-document navigation of the handbook. > > Let me describe the problem: > > Let's say I am reading in > http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/securing-freebsd.html > I came there by a link in another document or google. > > Now I want to go two levels up. > > In the current docs I've got to scroll 16 pages down (mouse wheel), to find a > link "Up", that brings me one level up (Chapter 14), and "Home" to go > directly to the contents page (but not at position of chapter 14). > When I chose to follow the "Up"-Links I'll never reach the contents page -- I > get stuck in a chapter III content page without a "Home" link. > > I'ld like to suggest to make the following changes: > 1. Rename "Home" link to "Content". > 2. The "Content" or "To content" link should be a link with #anchor > target in the content page. > 3. Add navigation links at the top of each page. > Example: > "FreeBSD Handbook" can be a link to the content page, with local > anchor target where chapter 14 is on the content page. > "Chapter 14 Security": "Chapter 14" can be a link to > http://www.freebsd.org/....859-1/books/handbook/security.html". > > I think these changes would improve the usability of the handbook. I think I understood most of the above. You have some very good ideas that would probably benefit the readers of the online Handbook a lot, with only minimal changes to our HTML docs. Can you please describe the changes you would find useful to the freebsd-doc@freebsd.org mailing list, since that's the place where many documentation committers hang out? Thanks for your helpful comments :) - Giorgos