From owner-freebsd-doc@FreeBSD.ORG Tue Feb 26 17:19:14 2013 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 70C386F9; Tue, 26 Feb 2013 17:19:14 +0000 (UTC) (envelope-from gkeramidas@gmail.com) Received: from mail-wg0-f46.google.com (mail-wg0-f46.google.com [74.125.82.46]) by mx1.freebsd.org (Postfix) with ESMTP id D8A0E1129; Tue, 26 Feb 2013 17:19:13 +0000 (UTC) Received: by mail-wg0-f46.google.com with SMTP id fg15so3536221wgb.13 for ; Tue, 26 Feb 2013 09:19:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=x-received:sender:date:from:to:cc:subject:message-id:references :mime-version:content-type:content-disposition:in-reply-to; bh=vjHWWGtRI1d/foQzRBlDQ/5VK/BvceGZRzGfiE7bNTg=; b=CP5Kq+HkDYj87Csac461y3eb2eDPW2ohOgC5v7Cu85309EzyX9s473rlMwZJUal4mI c0mFFB11Nn0W/Fd2iYTnFW1jbpZpjjc44G3kHEhbswaBCd49LtMFZOaL5k9zxnN6WPfy YOtT2GsKJKaOsA88Lx//H7nCM6V48BwhbV4wsnArnmAeX1cHgVdDWs2d3c6OR1Agwbtl WuwDF20tBb3rfLkYyUi7yKpVr4Iomp4/EwB26BVP9G+XuVR9tPTEHxnh+96mmYiRM7LI lFRXYyR0ckOSjlXYqX0nKZvIMx4b9PiKxR7TF3P0oen57esW1p3uEWAs8iZyjZpzfW/Z Tghg== X-Received: by 10.180.105.67 with SMTP id gk3mr20782453wib.31.1361899152554; Tue, 26 Feb 2013 09:19:12 -0800 (PST) Received: from saturn (217-162-217-29.dynamic.hispeed.ch. [217.162.217.29]) by mx.google.com with ESMTPS id o8sm22303456wix.7.2013.02.26.09.19.10 (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Tue, 26 Feb 2013 09:19:11 -0800 (PST) Sender: Giorgos Keramidas Date: Tue, 26 Feb 2013 18:19:07 +0100 From: Giorgos Keramidas To: Tom Rhodes Subject: Re: Do we care for manpage links in elements? Message-ID: <20130226171905.GA10642@saturn> References: <20130226124932.GA7258@saturn> <20130226134414.GA8899@saturn> <20130226094528.6cff2a60.trhodes@FreeBSD.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <20130226094528.6cff2a60.trhodes@FreeBSD.org> Cc: freebsd-doc@freebsd.org X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Documentation project <freebsd-doc.freebsd.org> List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-doc>, <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe> List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc> List-Post: <mailto:freebsd-doc@freebsd.org> List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help> List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>, <mailto:freebsd-doc-request@freebsd.org?subject=subscribe> X-List-Received-Date: Tue, 26 Feb 2013 17:19:14 -0000 On 2013-02-26 09:45, Tom Rhodes <trhodes@FreeBSD.org> wrote: >On Tue, 26 Feb 2013 14:44:15 +0100 Giorgos Keramidas <keramida@FreeBSD.org> wrote: >>On 2013-02-26 13:49, Giorgos Keramidas <keramida@FreeBSD.org> wrote: >>> Hi everyone, >>> I just noticed that in all the places where a chapter <title> includes a >>> &an.xxx.section; entity the rendering in HTML output sucks a bit. Note >>> how there are two separate links in the 'Using rc(8) Under FreeBSD' >>> title in the following screenshot: >>> >>> http://people.freebsd.org/~keramida/rc8-title-link.png >> >> This sort of diff fixes the title-link rendering: >> http://bitbucket.org/keramida/doc-work/commits/d44757193d819f1c950f0236801a37ef77d4711a >> >> But this is admittedly a "hack", and the optimal solution would be to >> conditionally render &man.foo.N; differently in <title> elements. > > Change the title "Using Run Control (RC)" This is not the only case where <title> embeds a &man.xxx.N; link, so I think we need a more general plan for all of them :-) %%% kobe:/hg/freebsd/doc-work/en_US.ISO8859-1$ grep -r '<title>.*\&man\..*\.[0-9];' . ./articles/nanobsd/article.xml: <title>Using &man.ftp.1; ./articles/nanobsd/article.xml: Using &man.ssh.1; ./articles/nanobsd/article.xml: Using &man.nc.1; ./books/arch-handbook/jail/chapter.xml: &man.jail.2; System Call ./books/fdp-primer/sgml-primer/chapter.xml: <filename>.profile</filename>, for &man.sh.1; and ./books/fdp-primer/sgml-primer/chapter.xml: <title><filename>.cshrc</filename>, for &man.csh.1; and ./books/handbook/bsdinstall/chapter.xml: <title>Writing the Image with &man.dd.1; ./books/handbook/config/chapter.xml: Tuning with &man.sysctl.8; ./books/handbook/config/chapter.xml: &man.sysctl.8; Read-only ./books/handbook/disks/chapter.xml: Using &man.sysinstall.8; ./books/handbook/disks/chapter.xml: Serial Access with &man.sa.4; ./books/handbook/disks/chapter.xml: Swap Encryption with &man.gbde.8; ./books/handbook/disks/chapter.xml: Swap Encryption with &man.geli.8; ./books/handbook/install/chapter.xml: Writing the Image with &man.dd.1; ./books/handbook/mac/chapter.xml: The &man.mac.seeotheruids.4; Module ./books/handbook/mac/chapter.xml: The &man.mac.bsdextended.4; Module ./books/handbook/mac/chapter.xml: The &man.mac.ifoff.4; Module ./books/handbook/mac/chapter.xml: The &man.mac.portacl.4; Module ./books/handbook/mac/chapter.xml: The &man.mac.partition.4; Module ./books/handbook/mac/chapter.xml: Error: &man..secure.path.3; cannot stat ./books/handbook/users/chapter.xml: <title>Adding a Group Using &man.pw.8; ./books/handbook/users/chapter.xml: Adding a New Member to a Group Using &man.pw.8; ./books/handbook/users/chapter.xml: Using &man.id.1; to Determine Group Membership kobe:/hg/freebsd/doc-work/en_US.ISO8859-1$ %%% If there are no serious objections I'll convert all of these to the text-only version of the same manpage(section) at first, to fix the immediate rendering problem. Then if/when I find a way to automatically do the right thing in elements, I'll do that too.