[Pmwiki-users] (:addcomment:) markup

Knut Alboldt pmwiki
Thu Oct 28 08:03:01 CDT 2004


I'm on my way to implement a (:addcomment:) markup for v2. ( I need this 
for error-tracking)

I know there is an x-comment for v1 but that adds comment in different pages 
to another page.

Just before I set this up as a cookbook-entry and want your remarks on it 
(or just the hint that all is already implemented somewhere :-).

I want to implement a feature that adds user comments as textblocks to an
existing page. So here are the topics I want to implement:

* adding a new markup (:addcomment:) / (:addcomment pagename:) to display a
  link like ...?pagename=$self/specified?action=addcomment?referer=$pagename
* adding new action=addcomment which displays a form to enter additional text 
  which is added as a user's comment to the specified page
* the comment-page can be a separate comment-page which is linked or included
  in the page to be commented or it can be the same page (then you can omit 
  the parameter "pagename")
* the style / format of the input-form will be specified within a pagefmt-
  vaiable ($PageAddcommentFmt ?). The default will contain $AddcommentPagetext
  which will contain the text of the page to be commented, an text emtry field
  to enter the user's comment and $AddcommentSuffix and $AddcommentPrefix as
  text to be put in front and behind the user's comment
* a global var $AddcommentWhere (or $Addcomment['where'] ?) which specifies
  where the user's comment will be placed within the specified text:
  'top' or 'bottom' (t/b)
* a global var $AddcommentPrefix (or $Addcomment['prefix']) which contains
  text, that will be copied before the user's comment (e.g. !!~~~~)
* a global var $AddcommentSuffix (or $Addcomment['suffix']) which contains
  text, that will be copied after the user's comment (e.g. ----)
* possibly the entered comment will be kept in a style blocked which can
  be referenced in css by .usercomment and/or .$Author (have to see)

The referred pagetext can be changed while the user enteres the comments
I wont take care of that in the first step.

Sorry for this long message, but I didn't want to write a cookbook-entry
before the feature is implemented (or should those suggestion put in PITS?).

Please tell me your thoughts about it.

Knut




More information about the pmwiki-users mailing list