From owner-freebsd-doc@FreeBSD.ORG Wed Aug 29 17:45:39 2012 Return-Path: Delivered-To: doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 0D956106564A for ; Wed, 29 Aug 2012 17:45:39 +0000 (UTC) (envelope-from simon@qxnitro.org) Received: from mail-iy0-f182.google.com (mail-iy0-f182.google.com [209.85.210.182]) by mx1.freebsd.org (Postfix) with ESMTP id B65598FC14 for ; Wed, 29 Aug 2012 17:45:38 +0000 (UTC) Received: by ialo14 with SMTP id o14so2044995ial.13 for ; Wed, 29 Aug 2012 10:45:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=qxnitro.org; s=google; h=mime-version:x-originating-ip:in-reply-to:references:date :message-id:subject:from:to:cc:content-type; bh=Qh5thKXqdZAwIAwNkx7CmUalaUgdfHFTZlChCVGmM8g=; b=OL9jkDBaF9cpt4WEVxg/0XKy5TB+WrjwNSPsXItTc5GqfK1f1QqwPlSzniz3d2o7+i AP3KYELJMvXPvyOtGRYFneLUZGrVqgNfeJAJ03gm7kdnuD2Dw6grf+5bJtJmo9OZ+wLJ MBzaX7biyuBEegHYQvA7BxFGN64Vze6q8eQLM= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=mime-version:x-originating-ip:in-reply-to:references:date :message-id:subject:from:to:cc:content-type:x-gm-message-state; bh=Qh5thKXqdZAwIAwNkx7CmUalaUgdfHFTZlChCVGmM8g=; b=lK0tGiINPSYnt9v7EmwNM5WQlU10VdaCLTHOqvW68o6hGcuJIOMkzwgAurmn7LOhEL uCvAEphCmtDatnJvlqEa+5/51KA9dPAFjfT6PdY08yO9PndWL4ZNikUrdfIAUhKoLAmy 3vAFgXitTEBjHndqxFJpTSEA/F61kC/wsNC/grfa2SLfyP5utCz4aFV3fYD9RBcy8SIx k+H9+LRW56Fze1JNh/Z/QZEUUX3f9ycWxb4KOq70Yb7cHLzuh58LnX7tGhIPco35pyIv 0MxYQs7Z04I8vTA3p9Pf7uWXohso0G2RtDz+rW9kr5e3orc+AffkHxVm2qbrpPgdATlm F+IQ== MIME-Version: 1.0 Received: by 10.50.194.130 with SMTP id hw2mr2827318igc.64.1346262332024; Wed, 29 Aug 2012 10:45:32 -0700 (PDT) Received: by 10.64.102.104 with HTTP; Wed, 29 Aug 2012 10:45:31 -0700 (PDT) X-Originating-IP: [131.111.143.140] In-Reply-To: References: <50390426.40604@FreeBSD.org> <20120826.025845.2271349946315727916.hrs@allbsd.org> <50392481.1070708@FreeBSD.org> <20120829.221019.266908030257017857.hrs@allbsd.org> Date: Wed, 29 Aug 2012 18:45:31 +0100 Message-ID: From: "Simon L. B. Nielsen" To: Warren Block Content-Type: text/plain; charset=UTF-8 X-Gm-Message-State: ALoCoQlfr0t6oRbB+I6HJqPJ4N4xUShsAeaP7kq9Ls58YDJU+2wm777+4E6+LeDSLZOyr93t4dOY Cc: doceng@freebsd.org, doc@freebsd.org, gabor@freebsd.org, www@freebsd.org Subject: Re: [CALL FOR REVIEW] doc and www converted to XML X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 29 Aug 2012 17:45:39 -0000 On Wed, Aug 29, 2012 at 3:52 PM, Warren Block wrote: > On Wed, 29 Aug 2012, Hiroki Sato wrote: > >> Gabor Kovesdan wrote >> in <50392481.1070708@FreeBSD.org>: >> >> ga> Em 25-08-2012 19:58, Hiroki Sato escreveu: >> ga> > Ah, what I wanted to point out is that not only in the headers the >> ga> > ids are converted to lower case in the new framework. I also >> ga> > think we can ignore the impact for the headers. >> ga> > >> ga> > As you know, the Jade program uses the upper case because it >> ga> > supports SGML general name normalization for the ids and NAMECASE >> ga> > GENERAL is YES in SGML declaration for HTML. The xsltproc program >> ga> > does not always do so because NAMECASE GENERAL is always NO in >> ga> > XML. >> ga> >> ga> Ok, now I see you are referring to docs not www. I was talking about >> ga> www because I only did manual conversion there. A side effect of >> ga> changing the SGML declaration used by Jade to enforce XML syntax is >> ga> that NAMECASE GENERAL is NO as you said. For now, I don't know what to >> ga> do with that. If we start using XSLT, we can customize the DocBook XSL >> ga> stlyesheets to do such a normalization. I think it shouldn't be >> ga> difficult but I'll have to see how the corresponding parts are written >> ga> in DocBook XSL. Do you have any suggestions how to handle this for the >> ga> interim period? >> >> If we continue to use the upper-case ids, converting all of id attr >> and xref's linkend attr to upper-case in the source file, not in the >> style sheet, is needed. Case normalization of ids by XSLT is wrong >> because relationship between xref's linkend and id must be correct in >> the XML source files. >> >> I am still wondering if we should stick to the upper-case ids, but >> considering consistency and compatibility, using upper-case is the >> safest. Our possible options in my mind are: >> >> 1. Convert ids to upper-case and use them. No compatibility problem. What are the arguments against this? It's at least the simplest one... >> 2. Use lower-case ids. Links from pages outside of www.FreeBSD.org >> may be broken. > > Is it practical to generate small static "This link has changed" pages for > legacy uppercase links? That does sound a bit painful... many small files around for a long time. The redirect is better, though it won't work for mirrors.... > Generating a list of "RedirectMatch permanent" lines for manual addition to > the webserver config seems more elegant. After the switch was made to all > lowercase, the list of obsolete uppercase links would not grow. How many are we talking about? I would prefer not having many redirects which have to keep around forever. -- Simon L. B. Nielsen