Shorewall devel - Dec 2003 - Funny characters in http://www.shorewall.net/FAQ.htm

Hello Mike, Tom, (I am not sure who is working on this part)


There are some funny characters in FAQ.htm in a number of places.
I have provided a precursory analysis of this issue. It is not a big=20
deal, but something that I imagine will be worked out at some point.

I have provided a couple examples.

Is there a way I can see the xslt stylesheets?

Could they live in cvs at some point? Maybe I could be more specific in=20
pointing out issues this way, or even fix them myself.

Hopefully this is helpful. Let me know if it is not.


EXAMPLE 1:

 From http://shorewall.net/FAQ.htm:

In FAQ 1c, in the table for the rules example, in the "SOURCE" and=20
"ORIG. DEST." coulmns, there is a character "=C2"

ANALYSIS 1:

The code for the content row (where the "=C2" ends up) from FAQ.xml
after=20
a fresh cvs update is:

<row>
<entry>DNAT</entry>
<entry>net</entry>
<entry>loc:192.168.1.3:22</entry>
<entry>tcp</entry>
<entry>1022</entry>
<entry/>		# translator inserts "=C2" here
<entry/>		# translator inserts "=C2" here
</row>

This indicates that the translator does not deal properly with the null=20
<entry/> I would think. I do know that this is a valid xml tag.



EXAMPLE 2:

 From http://shorewall.net/FAQ.htm:

"
(FAQ 1a) Ok -- I followed those instructions but it doesn''t work

Answer: That is usually the result of one of three things:

*	You are trying to test from inside your firewall (no, that won''t
work=20
-- see the section called =E2=80=9C(FAQ 2) I port forward www requests to=20
www.mydomain.com (IP 130.151.100.69) to system 192.168.1.5 in my local=20
network. External clients can browse http://www.mydomain.com but=20
internal clients can''t.=E2=80=9D).
"

HTML of above browser output:

<li><p>You are trying to test from inside your firewall (no, that
             won''t work -- see <a href=3D"#faq2"
title=3D"(FAQ 2) I port=20
forward www requests to www.mydomain.com (IP&#10;      130.151.100.69)=20
to system 192.168.1.5 in my local network. External&#10;      clients=20
can browse http://www.mydomain.com but internal clients&#10;=20
can''t.">the section called =E2=80=9C(FAQ 2) I port forward www
requests to=20
www.mydomain.com (IP
       130.151.100.69) to system 192.168.1.5 in my local network. External
       clients can browse http://www.mydomain.com but internal clients
       can''t.=E2=80=9D</a>).</p></li>


Notice the characters before "(FAQ 2)" and the "?"
Also the benign &#10.


ANALYSIS 2:

Looking at the list item from FAQ.xml for the source of the parargraph=20
with the funny chars from the above html output:

<para>
You are trying to test from inside your firewall (no, that
             won''t work -- see
<xref linkend=3D"faq2"/>
).
</para>

Looking at FAQ.xml again:

<section id=3D"faq2">
<title>
(FAQ 2) I port forward www requests to www.mydomain.com (IP
       130.151.100.69) to system 192.168.1.5 in my local network. External
       clients can browse http://www.mydomain.com but internal clients
       can''t.
</title>

Thus, the <xref linkend=3D"faq2"/> translates to:

<a href=3D"#faq2"
title=3D"(FAQ 2) I port forward www requests to www.mydomain.com
(IP&#10;=20
130.151.100.69) to system 192.168.1.5 in my local network. External&#10;=20
clients can browse http://www.mydomain.com but internal clients&#10;=20
can''t.">
the section called =E2=80=9C(FAQ 2) I port forward www requests to=20
www.mydomain.com (IP 130.151.100.69) to system 192.168.1.5 in my local=20
network. External clients can browse http://www.mydomain.com but=20
internal clients can''t.=E2=80=9D
</a>

The xref translation definition is definitely inserting the trailing=20
question mark. It is also inserting "the section called".

I would think the definition for the "xref" translation is also=20
inserting these funny chars as well.

(END ANALYSIS)




-Alex

On Thu, 2003-12-11 at 20:00, Alex Martin wrote:
> Hello Mike, Tom, (I am not sure who is working on this part)
> 
> There are some funny characters in FAQ.htm in a number of places.
> I have provided a precursory analysis of this issue. It is not a big 
> deal, but something that I imagine will be worked out at some point.
Alex,
I noticed them too. I''ll investigate the problem later.

I''m trying to get Docmentation.xml finished tonight.
> Is there a way I can see the xslt stylesheets?
    DocBook XSL Stylesheet Documentation
    http://docbook.sourceforge.net/release/xsl/current/doc/
    
    docbook-xsl 1.62.4
    http://dl.sourceforge.net/docbook/docbook-xsl-1.62.4.tar.gz

> Hopefully this is helpful. Let me know if it is not.
What would be very beneficial is looking into the XSL params.

    DocBook XSL: The Complete Guide
    http://www.sagehill.net/docbookxsl/

-- 
Mike Noyes <mhnoyes at users.sourceforge.net>
http://sourceforge.net/users/mhnoyes/
SF.net Projects: ffl, leaf, phpwebsite, phpwebsite-comm, sitedocs