This page discusses various forms of comments and how to achieve them for wiki pages.
The word comment can mean many things. Here are some possible interpretations:
A source comment is typically only intended to show up when an author edits a page. Source comments are not included in the generated page output. Conditional markup is one method of writing such a comment that is easy to create. Here is an example:
Bla... (:if false:) This text is a comment. It won't be shown, nor appear in the generated HTML output (:ifend:) bla.
In this case the source comment will not be exported to the HTML.
The other method is to to use the special directive
(:comment:) for comments that produces no output.
Here is an example:
Bla... (:comment Here is a comment that produces no output:) bla.
If you want the comment to appear in the html source of the page, you should instead make the comment invisible.
You could use the predefined wiki style
%comment% for this purpose. Here
Bla... %comment% This will be present, but hidden or invisible in the resulting output. >>comment<< This text will be hidden or invisible in the resulting output. You can have several lines of comments when writing like this. >><< bla.
Bla... This will be present, but hidden or invisible in the resulting output.
This text will be hidden or invisible in the resulting output. You can have several lines of comments when writing like this.
# Bla... # This will be present, but hidden as well %item comment% # bla.
An example of a visible reader comment in a page using a wiki style to mark text as being a comment that appears with a special format.
%define=commentary apply=block background-color=#f8dce1 margin=1em border="1px dotted #ea97a4"%%% Bla... %commentary% This is a comment created using a wiki style %% >>commentary<< so is this >><< bla.
As an alternative to the commenty style defined above, it could have been defined by adding the following to the local configuration file:
$WikiStyle['commentary']['apply'] = 'block'; $WikiStyle['commentary']['background-color'] = '#f8dce1'; $WikiStyle['commentary']['margin'] = '1em'; $WikiStyle['commentary']['border'] = '1px dotted #ea97a4';
Information found here
Tutoriais de Tecnologia Web