Date: Fri, 31 Aug 2012 00:52:44 +0900 (JST) From: Hiroki Sato <hrs@FreeBSD.org> To: gabor@FreeBSD.org Cc: doceng@FreeBSD.org, doc@FreeBSD.org, www@FreeBSD.org Subject: Re: [CALL FOR REVIEW] doc and www converted to XML Message-ID: <20120831.005244.2295575122657925960.hrs@allbsd.org> In-Reply-To: <503E7E70.2050504@FreeBSD.org> References: <50392481.1070708@FreeBSD.org> <20120829.221019.266908030257017857.hrs@allbsd.org> <503E7E70.2050504@FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
----Security_Multipart(Fri_Aug_31_00_52_44_2012_228)-- Content-Type: Text/Plain; charset=us-ascii Content-Transfer-Encoding: 7bit Gabor Kovesdan <gabor@FreeBSD.org> wrote in <503E7E70.2050504@FreeBSD.org>: ga> Em 29-08-2012 15:10, Hiroki Sato escreveu: ga> > 1. Convert ids to upper-case and use them. No compatibility ga> > problem. ga> > ga> > 2. Use lower-case ids. Links from pages outside of ga> > www.FreeBSD.org may be broken. ga> > ga> > 3. Convert the existing ids to upper-case but use lower case for ga> > newly-added ones. It works but not consistent. ga> ga> 4. Use some kind of redirection at the HTTP level. Let's forget about HTTP level solution. On the mirror servers it does not work. ga> I'd prefer (2) or (4). I think we already carry a lot of legacy stuff ga> and people frequently come up with the idea of using some kind of ga> markdown or wiki system for documentation and try to recruit more ga> people to support this idea because the current situation is much more ga> complicated than it could. I think going to XML and dropping character ga> entities highly helps people writing docs and simplifying things. So ga> I'd prefer avoiding one more not really sensible policy and confusion ga> factor. Using upper-case names affects readability and suggests that ga> it is a policy or a practice to follow even if we go for (3). Besides, ga> please take into account that we never care of broken links when we ga> remove a chapter or section and that links may still bring you to the ga> proper page just not to the proper part. The user may still find the ga> part she is looking for. One compromise solution would be adding an additional anchor with upper-case ids just after the normal (lower-case) one by XSLT only for HTML output. It is relatively easy and should not be harmful. How about this? Hmm, I agree that upper-case ids are annoying but cannot agree that we never took care of anchors and/or we can ignore the negative impact from changing them. We should take care of them as far as we can. Just converting them to lower-case is different from the case of removal of a section because it is not non-avoidable. -- Hiroki ----Security_Multipart(Fri_Aug_31_00_52_44_2012_228)-- Content-Type: application/pgp-signature Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.11 (FreeBSD) iEYEABECAAYFAlA/jEwACgkQTyzT2CeTzy1XHACcCidtyMHazJ6LnmTwZgFZ4fiN NaYAniOOBJsulR4QPFC3cEX35WnHGDfx =Wy1g -----END PGP SIGNATURE----- ----Security_Multipart(Fri_Aug_31_00_52_44_2012_228)----
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20120831.005244.2295575122657925960.hrs>