You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@isis.apache.org by Dan Haywood <dk...@gmail.com> on 2010/11/11 09:20:43 UTC

Re: parameterizing the docbook references to the DTD

Hi Kevin,
I think whatever approach we end up with for this issue, it will be 
necessary to support editing in XmlMind.

Rather than parameterizing the reference to the DTD (which from your 
commit below looks like it's turning out to be problematic anyway) 
perhaps another option might to use an svn:externals property.  This 
allows us to create the equivalent of symbolic links in each directory.

For example, given:

a/foo
a/b/bar

if you wanted to reference "foo" relative to a/b, you would create an 
svn:external property for a/b with a value "../foo foo"

Might be worth experimenting with?

Dan


On 11/11/2010 07:43, kevin@apache.org wrote:
> Author: kevin
> Date: Thu Nov 11 07:43:10 2010
> New Revision: 1033829
>
> URL: http://svn.apache.org/viewvc?rev=1033829&view=rev
> Log:
> I can't get POM definitions to be interpreted in the xml.
>
> Modified:
>      incubator/isis/trunk/alternatives/objectstore/sql/src/docbkx/guide/isis-sql-objectstore.xml
>
> Modified: incubator/isis/trunk/alternatives/objectstore/sql/src/docbkx/guide/isis-sql-objectstore.xml
> URL: http://svn.apache.org/viewvc/incubator/isis/trunk/alternatives/objectstore/sql/src/docbkx/guide/isis-sql-objectstore.xml?rev=1033829&r1=1033828&r2=1033829&view=diff
> ==============================================================================
> --- incubator/isis/trunk/alternatives/objectstore/sql/src/docbkx/guide/isis-sql-objectstore.xml (original)
> +++ incubator/isis/trunk/alternatives/objectstore/sql/src/docbkx/guide/isis-sql-objectstore.xml Thu Nov 11 07:43:10 2010
> @@ -15,10 +15,16 @@
>     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
>     KIND, either express or implied.  See the License for the
>     specific language governing permissions and limitations
> -  under the License.
> --->
> +  under the License.
> +
>   <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
> -"file:./resources/docbook-xml-4.5/docbookx.dtd">
> +"file:${resourceDir}/resources/docbook-xml-4.5/docbookx.dtd">
> +
> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
> +"file:&resourceDir;/resources/docbook-xml-4.5/docbookx.dtd">
> +-->
> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
> +"file:./resources/docbook-xml-4.5/docbookx.dtd">
>   <book>
>     <bookinfo>
>       <title><?eval ${docbkxGuideTitle}?></title>
>
>
>

Re: parameterizing the docbook references to the DTD

Posted by Kevin Meyer - KMZ <ke...@kmz.co.za>.
See below

> I think whatever approach we end up with for this issue, it will be 
> necessary to support editing in XmlMind.
> 
> Rather than parameterizing the reference to the DTD (which from your 
> commit below looks like it's turning out to be problematic anyway) 
> perhaps another option might to use an svn:externals property.  This 
> allows us to create the equivalent of symbolic links in each directory.

almost..

> For example, given:
> 
> a/foo
> a/b/bar
> 
> if you wanted to reference "foo" relative to a/b, you would create an 
> svn:external property for a/b with a value "../foo foo"

The websites[1][2] and help file [3] I've been reading specifically say 
that relative paths do not work (as source).

> Might be worth experimenting with?

I don't think so. The svn:properties seems to me to still just be a 
method of merging other subversion repository locations into an 
existing managed tree. I don't see how it can be used to ensure that a 
resource is available at a known (fixed) location.

The fact that I can't get the maven docbook plugin to parse the text in 
the <!DOCBOOK ...> header is the killer. So I come back to one of 
two suggestions:
1) Keep the docbook references relative to the trunk directory.
2) Specify an acceptable global directory (like /tmp/isis) and run a 
script to ensure that the /trunk/resources/docbook-xml-4.5 directory is 
copied there.

Option 2 will ensure that all references can find it in the same place.
Option 1 requires that scripts are run from trunk before documentation 
gets built.

Otherwise, can anyone recommend a parsing script that can be used 
easily toggle between either of the two definitions?
a:
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"file:/tmp/isis/resources/docbook-xml-4.5/docbookx.dtd">

b:
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

When I open any of the docbook files with XML Mind, e.g.
trunk/alternatives/remoting/src/docbkx/guide/isis-remoting.xml
XMLMind didn't seem affected by the relative path to the DTD?


Regards,
Kevin


[1] http://svnbook.red-bean.com/en/1.0/ch07s03.html
[2] http://beerpla.net/2009/06/20/how-to-properly-set-svn-
svnexternals-property-in-svn-command-line/
[3] svn help propset svn:externals