Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 193792004A0 for ; Wed, 16 Aug 2017 16:16:44 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 17B2E168B5C; Wed, 16 Aug 2017 14:16:44 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 0FCD0168B58 for ; Wed, 16 Aug 2017 16:16:42 +0200 (CEST) Received: (qmail 14667 invoked by uid 500); 16 Aug 2017 14:16:37 -0000 Mailing-List: contact docs-help@httpd.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: docs@httpd.apache.org List-Id: Delivered-To: mailing list docs@httpd.apache.org Received: (qmail 14657 invoked by uid 99); 16 Aug 2017 14:16:36 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 16 Aug 2017 14:16:36 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id 847561A1883 for ; Wed, 16 Aug 2017 14:16:36 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -0.401 X-Spam-Level: X-Spam-Status: No, score=-0.401 tagged_above=-999 required=6.31 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=2, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-2.8, RCVD_IN_SORBS_SPAM=0.5, SPF_PASS=-0.001] autolearn=disabled Authentication-Results: spamd2-us-west.apache.org (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id 5BGsFq0iWSQb for ; Wed, 16 Aug 2017 14:16:34 +0000 (UTC) Received: from mail-wr0-f170.google.com (mail-wr0-f170.google.com [209.85.128.170]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with ESMTPS id E7A055FAF7 for ; Wed, 16 Aug 2017 14:16:33 +0000 (UTC) Received: by mail-wr0-f170.google.com with SMTP id 49so8677348wrw.2 for ; Wed, 16 Aug 2017 07:16:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:in-reply-to:references:from:date:message-id:subject:to; bh=trmujgK/klWFW4AuAoAh3jw9Uh0ERWf09JcvC6SrXXE=; b=QBcQa7+4MWql+iTE7F8k5pqA7le51sZjbq6QADueWmXGkB24LSCO9x3vJk1aQCPlj2 8aoj9xvD5z0yY4ayiEW1aw+ClucZKjNprJ9fMsi9fjZcvPZ4sqPwyUWMgZQ8zSgBKHBq DlS4ubVpGShXYyJj/MTy8uAzY39go08/sSOtiCGnbDp8piSpillbTg+KdaTQ6n0gXBZ7 9NMfVjElEFL61kaShgxeGARQbJt4odcOyzPbWVL3ZnYjSHstOjOuxNfZotdHI5ht9VRT wqUMIWY/nPZA7Ac4z7b+UVqcKum17SiqlSjFp3WVAd1+KFcxsMeDFxoVVA7F3vky02V+ +E9Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to; bh=trmujgK/klWFW4AuAoAh3jw9Uh0ERWf09JcvC6SrXXE=; b=RZBeQq9Y3xTKV7jVU2CbDzbRib2radd3BfusBbw2+Tmzqju/sNfQT71SeJ4zhzTSr/ 3M0q88jBoqza0d6s2AePtXXB2ZtcBnALIPNLukYgR7oFdmla+zbo2gJ1brbMyr3q53mX i93czG58q3MPmGXNRreZvRaZd8XuLajaDQ8IMUxA4dPv8ObTJtPXcIVPXZLAKjq6ITIQ Zn/SdniTxO7pPM/idc8WiPsmt0e1kto46iLOAfjMmWHfhyrmO8RDcGrSvkA997wbbJ3i yGyXtMm0ripXVakLniEmdql+FS7HOfAx+z+nA2P6zb1JWiwZNg93Devz4yfVfWpZ6iQB VMjg== X-Gm-Message-State: AHYfb5hV7cZYm/umJwVM3w8wK853qICXaIVk2bXS7YWuxNImGReu/tTO ZG3mhvj3lYx9EYjSefIj72UquCGMNSZMJOs= X-Received: by 10.80.182.238 with SMTP id f43mr2183229ede.44.1502892993391; Wed, 16 Aug 2017 07:16:33 -0700 (PDT) MIME-Version: 1.0 Received: by 10.80.177.36 with HTTP; Wed, 16 Aug 2017 07:16:33 -0700 (PDT) In-Reply-To: References: From: Luca Toscano Date: Wed, 16 Aug 2017 16:16:33 +0200 Message-ID: Subject: Re: mod_md documentation in trunk To: docs@httpd.apache.org Content-Type: multipart/alternative; boundary="f403045c4e9801af960556df8be7" archived-at: Wed, 16 Aug 2017 14:16:44 -0000 --f403045c4e9801af960556df8be7 Content-Type: text/plain; charset="UTF-8" 2017-08-13 23:11 GMT+02:00 Luca Toscano : > Hi again :) > > 2017-08-11 18:06 GMT+02:00 Luca Toscano : > >> Hi everybody, >> >> as you probably know Stefan added the first implementation of mod_md in >> trunk plus some documentation. I tried to build it and got rid of some >> errors with http://home.apache.org/~elukey/httpd-trunk-mod_md-doc_f >> ix.patch but then I can still see the following after running build.sh >> validate-xhtml: >> >> validate-xhtml: >> [xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en:170:79: >> Attribute value "ManagedDomain" of type ID must be unique within the >> document. >> [xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en:170:148: >> Attribute value "manageddomain" of type ID must be unique within the >> document. >> [xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en:193:79: >> Attribute value "ManagedDomain" of type ID must be unique within the >> document. >> [xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en:193:140: >> Attribute value "manageddomain" of type ID must be unique within the >> document. >> [xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en:264:79: >> Attribute value "ManagedDomain" of type ID must be unique within the >> document. >> [xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en:264:148: >> Attribute value "manageddomain" of type ID must be unique within the >> document. >> [xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en is not a valid >> XML document >> [xmlvalidate] 806 file(s) have been successfully validated. >> >> From synopsis.xml it seems to me that the problem is the fact that now we >> have a directive called ManagedDomain and a directive/context-block called >> that end up with the same id since they share the name (and >> also for some reason duplicate HTML, the sections are repeated two times). >> >> Any idea about how to fix this? >> > > I found a solution that works with this patch: http://home.apache.org/~ > elukey/httpd-trunk-mod_md-doc_fix.patch > > There are a couple of things that I needed to do but they should allow > having in the same document two directives like ManagedDomain and > (the latter is type=section): > > - Replace > with , since the former, when running in > a for loop, causes duplicates when two directives share the same name. I > hope that using select="." is fine, looking forward to feedback from more > experienced docs committers. > > - Change the id of each block with the concatenation of name + id, > that in this case would be "ManagedDomain" and "ManagedDomainsection" (and > their lowercase counterparts). Example from the transformation: > >

id="ManagedDomainsection"><ManagedDomain> name="manageddomainsection" id="manageddomainsection">Directive

> > The good thing about this change is that validate-xhtml will keep failing > if two directives are copied/pasted by accident (or simply repeated) but it > won't for legitimate cases like the ManagedDomain and of > mod_md. > > Hope that what I wrote makes sense, will wait a bit before pushing my > changes to gather some feedback. > So I committed all my changes separately to trunk in the following: http://svn.apache.org/r1805189 http://svn.apache.org/r1805193 Everything works fine and nice, but I just noticed a side effect that it wasn't intended, namely the section links like http://httpd.apache.org/docs/trunk/mod/core.html#ifsection (the old ones didn't have the "section" suffix). This might be resolved adding some redirects for the old few sections (like http://httpd.apache.org/docs/trunk/mod/core.html#if -> http://httpd.apache.org/docs/trunk/mod/core.html#ifsection) but it might also be possible that the best solution is rollback and find an alternative solution. Let me know your thoughts :) Luca --f403045c4e9801af960556df8be7 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable


2017-08-13 23:11 GMT+02:00 Luca Toscano <toscano.luca@gmail.com= >:
Hi again :)

2017-08-11 18:06 GMT+02:00 Luca Toscano <toscano.luca@gmail.com>:
Hi everybody,

as = you probably know Stefan added the first implementation of mod_md in trunk = plus some documentation. I tried to build it and got rid of some errors wit= h=C2=A0http://home.apache.org/~elukey/httpd-trunk-m= od_md-doc_fix.patch but then I can still see the following after r= unning build.sh validate-xhtml:

validate-xhtm= l:
[xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en:1= 70:79: Attribute value "ManagedDomain" of type ID must be unique = within the document.
[xmlvalidate] [..path..]/docs/manual/mod/mod= _md.html.en:170:148: Attribute value "manageddomain" of type= ID must be unique within the document.
[xmlvalidate] [..path..]/= docs/manual/mod/mod_md.html.en:193:79: Attribute value "ManagedDo= main" of type ID must be unique within the document.
[xmlval= idate] [..path..]/docs/manual/mod/mod_md.html.en:193:140: Attribute va= lue "manageddomain" of type ID must be unique within the document= .
[xmlvalidate] [..path..]/docs/manual/mod/mod_md.html.en:26= 4:79: Attribute value "ManagedDomain" of type ID must be unique w= ithin the document.
[xmlvalidate] [..path..]/docs/manual/mod/mod<= wbr>_md.html.en:264:148: Attribute value "manageddomain" of type = ID must be unique within the document.
[xmlvalidate] [..path..]/d= ocs/manual/mod/mod_md.html.en is not a valid XML document
[x= mlvalidate] 806 file(s) have been successfully validated.
<= br>
From synopsis.xml it seems to me that the problem is the fact= that now we have a directive called ManagedDomain and a directive/context-= block called <ManagedDomain> that end up with the same id since they = share the name (and also for some reason duplicate HTML, the sections are r= epeated two times).

Any idea about how to fix this= ?=C2=A0

I found a soluti= on that works with this patch: http://home.apache.org/~<= wbr>elukey/httpd-trunk-mod_md-doc_fix.patch

There are a couple of things that I needed to do but they should allow h= aving in the same document two directives like ManagedDomain and <Manage= dDomain> (the latter is type=3Dsection):

- Repl= ace <xsl:apply-templates select=3D"$this[name=3Dcurrent()/name= ]" /> with=C2=A0<xsl:apply-templates select=3D"." />= ;, since the former, when running in a for loop, causes duplicates when two= directives share the same name. I hope that using select=3D"." i= s fine, looking forward to feedback from more experienced docs committers.<= /div>

- Change the id of each <a> block with the c= oncatenation of name + id, that in this case would be "ManagedDomain&q= uot; and "ManagedDomainsection" (and their lowercase counterparts= ). Example from the transformation:

<div class= =3D"directive-section"><h2><a name=3D"Manag= edDomainsection" id=3D"ManagedDomainsection">&lt;ManagedDomain&gt;</a> <a name=3D"manageddomainsection&qu= ot; id=3D"manageddomainsection">Directive</a></h= 2>

The good thing about this change is that val= idate-xhtml will keep failing if two directives are copied/pasted by accide= nt (or simply repeated) but it won't for legitimate cases like the Mana= gedDomain and <ManagedDomain> of mod_md.

Hop= e that what I wrote makes sense, will wait a bit before pushing my changes = to gather some feedback.


So I committed all my changes separately to trunk in t= he following:


=
Everything works fine and nice, but I just noticed a side effect that = it wasn't intended, namely the section links like http://httpd.apache.org/d= ocs/trunk/mod/core.html#ifsection (the old ones didn't have the &qu= ot;section" suffix). This might be resolved adding some redirects for = the old few sections (like http://httpd.apache.org/docs/trunk/mod/core.html#if -&g= t;=C2=A0http://httpd.apache.org/docs/trunk/mod/core.html#ifsection) but it = might also be possible that the best solution is rollback and find an alter= native solution.

Let me know your thoughts :)

Luca=C2=A0

--f403045c4e9801af960556df8be7--