EPrints Technical Mailing List Archive

Message: #01183

< Previous (by date) | Next (by date) > | < Previous (in thread) | Next (in thread) > | Messages - Most Recent First | Threads - Most Recent First

[EP-tech] Re: Comments in XML configuration files: beware! (possibly needs fixing)

Hi John,
Try using <epc:comment/> instead (look at cfg/citations/eprint/summary_page.xml for an example). 

Seb.

On 15/10/12 14:18, John Salter wrote:

In case you weren't already aware...

Comments in XML configuration files (e.g. citations) will come through to the rendered page.
To me, this is an unexpected behaviour* - not sure what others think?

Example:
<choose>
   <when test="type = 'book' and is_set( creators )">
     <print expr="creators_name"/>
   </when>
   <when ...>
     ...
   </when>
   <otherwise>
    <!-- print nothing? Some variant of <print expr="creators_name"/>? -->
   </otherwise>
</choose>

Results in a literal HTML comment when none of the <when ...> statements are matched:
    <!-- print nothing? Some variant of <print expr="creators_name"/>? -->

It's fairly easy to look at the source code for an abstract page and see what's in there - not so easy to spot when just viewing the webpage itself!

Cheers,
John

*My reasoning for this being unexpected is that there are internal-comments in the file already e.g.
<!--
         Full citation for an eprint.
-->
I would not expect this to end up in the rendered page - and therefore not other comments!

*** Options: http://mailman.ecs.soton.ac.uk/mailman/listinfo/eprints-tech
*** Archive: http://www.eprints.org/tech.php/
*** EPrints community wiki: http://wiki.eprints.org/