Charles Karney | 14 Jun 2012 19:17

Additional HTML character entities (for Greek symbols, etc.)

I'm interested in adding support to Doxygen for the following HTML
character entities:

* Upper case greek: Γ Δ Θ Λ Ξ Π Σ
     Υ Φ Ψ Ω
* Lower case greek: α β γ δ ε ζ
     η θ ι κ λ μ ν ξ π ρ
     σ τ υ φ χ ψ ω
* Variants of lower case greek: ϵ ϑ ϰ
     ϖ ϱ ς ϕ
* Inequality relations: ≤ ≥ ≠

This all looks pretty straightforward (search for all occurrences of
AElig in the source and do the obvious thing).

* Please let me know if someone already has this in hand.
* Are there any potential pitfalls I should be aware of?
* Are there other HTML character entities I should consider adding?

Thanks.

--

-- 
Charles Karney <charles.karney <at> sri.com>
SRI International, Princeton, NJ 08543-5300

Tel: +1 609 734 2312
Fax: +1 609 734 2662

------------------------------------------------------------------------------
Live Security Virtual Conference
(Continue reading)

Acenes | 15 Jun 2012 08:34
Picon

qhelpgenerator input file index.qhp broken in doxygen 1.8.1.1

After updating to 1.8.1.1 the heplgenerator stopped working. In doxywizard all seems ok, no error messages – but no qch file generated.

 

When manually running qhelpgenerator against index.qhp, this error is displayed:

 

„Error in line 1231: Opening and ending tag mismatch.“

 

After reinstalling 1.8.1 everything works again.

 

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Dimitri Van Heesch | 15 Jun 2012 22:11
Picon
Gravatar

Re: qhelpgenerator input file index.qhp broken in doxygen 1.8.1.1

Hi Acenes,

Can you send me an example of a problematic file? or better; and example that allows me to reproduce the problem?

Regards,
  Dimitri

On Jun 15, 2012, at 8:34 , Acenes wrote:

> After updating to 1.8.1.1 the heplgenerator stopped working. In doxywizard all seems ok, no error
messages – but no qch file generated.
>  
> When manually running qhelpgenerator against index.qhp, this error is displayed:
>  
> „Error in line 1231: Opening and ending tag mismatch.“
>  
> After reinstalling 1.8.1 everything works again.
>  
> ------------------------------------------------------------------------------
> Live Security Virtual Conference
> Exclusive live event will cover all the ways today's security and 
> threat landscape has changed and how IT managers can respond. Discussions 
> will include endpoint security, mobile security and the latest in malware 
> threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/_______________________________________________
> Doxygen-develop mailing list
> Doxygen-develop <at> lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Petr Prikryl | 19 Jun 2012 12:50
Picon

Re: Additional HTML character entities (for Greek symbols, etc.)

> From: Charles Karney
> Sent: Thursday, June 14, 2012 7:17 PM
> 
> I'm interested in adding support to Doxygen for the following HTML
> character entities:
> 
> * Upper case greek: &Gamma; &Delta; &Theta; &Lambda; &Xi; &Pi; &Sigma;
>      &Upsilon; &Phi; &Psi; &Omega;
> * Lower case greek: &alpha; &beta; &gamma; &delta; &epsilon; &zeta;
>      &eta; &theta; &iota; &kappa; &lambda; &mu; &nu; &xi; &pi; &rho;
>      &sigma; &tau; &upsilon; &phi; &chi; &psi; &omega;
> * Variants of lower case greek: &varepsilon; &vartheta; &varkappa;
>      &varpi; &varrho; &varsigma; &varphi;
> * Inequality relations: &le; &ge; &ne;
> 
> This all looks pretty straightforward (search for all occurrences of
> AElig in the source and do the obvious thing).
> 
> * Please let me know if someone already has this in hand.
> * Are there any potential pitfalls I should be aware of?
> * Are there other HTML character entities I should consider adding?

In my opinion, the UTF-8 support is the way to go.  If the translator
class supports UTF-8, there should be no problem with generation of
the HTML in the UTF-8 encoding.

What is your exact goal?  Do you mean to translate the entities
from the source file into normal characters?

Thanks,
   Petr

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Charles Karney | 19 Jun 2012 17:50

Re: Additional HTML character entities (for Greek symbols, etc.)

My goal is to be able to include text such as

   &phi; %le; 30&deg;

in my source code and have the generated HTML documentation resemble the
TeX math: $\phi \le 30^\circ$.  I would prefer not to have to deal with
UTF-8 characters in my source files; lots of things will start to go
awry if I don't stick with plain old 7-bit ASCII in my source; also it's
faster for me to touch type &phi; than to figure out how to generate the
UTF-8.  (Oh and the generated HTML will just contain &phi; etc.)

There was already a mechanism for dealing with HTML entities and it was
simple enough to expand this.  Here's the list I ended up implementing
(I constrained myself to entities which appear correctly with the
default fonts for Firefox, Konqueror, and Internet Explorer).

* Upper case Greek: &Gamma; &Delta; &Theta; &Lambda; &Xi; &Pi; &Sigma;
   &Upsilon; &Phi; &Psi; &Omega;

* Lower case Greek: &alpha; &beta; &gamma; &delta; &epsilon; &zeta;
   &eta; &theta; &iota; &kappa; &lambda; &mu; &nu; &xi; &pi; &rho;
   &sigma; &tau; &upsilon; &phi; &chi; &psi; &omega; &sigmaf;

* Miscellaneous math symbols: &sect; &deg; &prime; &Prime; &infin;
   &empty; &plusmn; &times; &minus; &sdot; &part; &nabla; &radic; &perp;
   &sum; &int; &prod; &sim; &asymp; &ne; &equiv; &prop; &le; &ge; &larr;
   &rarr; &isin; &notin; &lceil; &rceil; &lfloor; &rfloor;

On 2012-06-19 06:50, Petr Prikryl wrote:
>> From: Charles Karney
>> Sent: Thursday, June 14, 2012 7:17 PM
>>
>> I'm interested in adding support to Doxygen for the following HTML
>> character entities:
>>
>> * Upper case greek:&Gamma;&Delta;&Theta;&Lambda;&Xi;&Pi;&Sigma;
>>       &Upsilon;&Phi;&Psi;&Omega;
>> * Lower case greek:&alpha;&beta;&gamma;&delta;&epsilon;&zeta;
>>       &eta;&theta;&iota;&kappa;&lambda;&mu;&nu;&xi;&pi;&rho;
>>       &sigma;&tau;&upsilon;&phi;&chi;&psi;&omega;
>> * Variants of lower case greek:&varepsilon;&vartheta;&varkappa;
>>       &varpi;&varrho;&varsigma;&varphi;
>> * Inequality relations:&le;&ge;&ne;
>>
>> This all looks pretty straightforward (search for all occurrences of
>> AElig in the source and do the obvious thing).
>>
>> * Please let me know if someone already has this in hand.
>> * Are there any potential pitfalls I should be aware of?
>> * Are there other HTML character entities I should consider adding?
>
> In my opinion, the UTF-8 support is the way to go.  If the translator
> class supports UTF-8, there should be no problem with generation of
> the HTML in the UTF-8 encoding.
>
> What is your exact goal?  Do you mean to translate the entities
> from the source file into normal characters?
>
> Thanks,
>     Petr

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Petr Prikryl | 20 Jun 2012 09:18
Picon

Re: Additional HTML character entities (for Greek symbols, etc.)

Charles Karney wrote:
>
> My goal is to be able to include text such as
> 
>    &phi; %le; 30&deg;
> 
> in my source code and have the generated HTML documentation resemble
> the TeX math: $\phi \le 30^\circ$.  I would prefer not to have to deal
> with UTF-8 characters in my source files; lots of things will start to go
> awry if I don't stick with plain old 7-bit ASCII in my source; also
> it's faster for me to touch type &phi; than to figure out how to
> generate the UTF-8.  (Oh and the generated HTML will just contain &phi;
> etc.)
> 
> There was already a mechanism for dealing with HTML entities and it was
> simple enough to expand this.  Here's the list I ended up implementing
> (I constrained myself to entities which appear correctly with the
> default fonts for Firefox, Konqueror, and Internet Explorer).

I see.  You should probably discuss that directly with Dimitri because
he is the one to accept/refuse the code.  He may know what the pitfalls
are.  It may be related to the other-format output generators (like 
the LaTeX one). 

Petr

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

Gmane