[Pmwiki-users] Re: Comments in new tmpl files

Christian Ridderström chr
Sun Feb 22 14:20:22 CST 2004


On Sun, 22 Feb 2004, John Feezell wrote:

> My thinking is along the following lines:
> 
> Take the Classic tmpl file.  In it are the following lines:
> <!--PageFooterFmt-->
>    <div id='wikifoot'>
>      <hr />
>      <div class='footnav'>
>        <a href='$PageUrl?action=edit'>$[Edit Page]</a> -
>        <a href='$PageUrl?action=diff'>$[Page History]</a> -
>        <a href='$PageUrl?action=print' target='_blank'>$[Printable 
> View]</a> -
>        <a href='$ScriptUrl/$[$Group/RecentChanges]'>$[Recent Changes]</a> -
>        <a href='$ScriptUrl/$[PmWiki/WikiHelp]'>$[WikiHelp]</a> -
>        <a href='$ScriptUrl/$[Main/SearchWiki]'>$[SearchWiki]</a></div>
>      <div class='lastmod'>$[Page last modified on $LastModified]</div></div>
> 
> I think that during development, maintenance, or documentation on a 
> template, it might be helpful to be able to do the following:
> <!--PageFooterFmt-->
>    <div id='wikifoot'>
>      <hr />
>      <div class='footnav'>
>        <a href='$PageUrl?action=edit'>$[Edit Page]</a> -
>        <a href='$PageUrl?action=diff'>$[Page History]</a> -
>        <a href='$PageUrl?action=print' target='_blank'>$[Printable 
> View]</a> -
> <!-- This section needs to be refined and extended. -JF 2/22/04
>        <a href='$ScriptUrl/$[$Group/RecentChanges]'>$[Recent Changes]</a> -
>        <a href='$ScriptUrl/$[PmWiki/WikiHelp]'>$[WikiHelp]</a> -
>        <a href='$ScriptUrl/$[Main/SearchWiki]'>$[SearchWiki]</a>
> -->
>      </div>
>      <div class='lastmod'>$[Page last modified on $LastModified]</div></div>
> 
> Hope this helps explain what I'm thinking about.

Um.. now I'm slighly confused. I think you mean that these lines
 <!-- This section needs to be refined and extended. -JF 2/22/04
        <a href='$ScriptUrl/$[$Group/RecentChanges]'>$[Recent Changes]</a> -
        <a href='$ScriptUrl/$[PmWiki/WikiHelp]'>$[WikiHelp]</a> -
        <a href='$ScriptUrl/$[Main/SearchWiki]'>$[SearchWiki]</a>
 -->
won't actually be used in the output, is that correct?

If you only want to put an internal comment there, as a reminder to 
yourself for late, I would have thought that should be written like this:
 <!-- This section needs to be refined and extended. -JF 2/22/04 -->
        <a href='$ScriptUrl/$[$Group/RecentChanges]'>$[Recent Changes]</a> -
        <a href='$ScriptUrl/$[PmWiki/WikiHelp]'>$[WikiHelp]</a> -
        <a href='$ScriptUrl/$[Main/SearchWiki]'>$[SearchWiki]</a>

/Christian

PS. Then there is of course the question if these comments should appear 
in the final HTML output... I'd say yes, but then you should avoid leaving 
embarrasing comments :-)

-- 
Christian Ridderstr?m                           http://www.md.kth.se/~chr





More information about the pmwiki-users mailing list