#format wiki
#language en
#pragma section-numbers off
#acl IanRiley:read,write,delete,revert,admin All:read

[[RileyLink|{{attachment:RileyLinkFiles/public/[ir].png||align="left",height=35,width=35,target="./RileyLink"}}]]{{attachment:RileyLinkFiles/public/blank.png||align="left",height=35,width=10}}
= Patch - Sticky Messages =
-----
== Issue ==

Messages displayed above the page content are usually temporary and can be cleared by clicking the `Clear message` link. However, with the implementation of page scheduling using the [[schedule.py]] parser, some messages on page availability or validity of scheduling arguments should not be cleared. To achieve this the `ThemeBase` class can be patched as follows.

== Patch ==

A simple patch to the ThemeBase class `MoinMoin.theme.__init__.py` can add stickness to page messages.

{{{#!highlight python

    def msg(self, d):
        """ Assemble the msg display

        Display a message with a widget or simple strings with a clear message link.

        @param d: parameter dictionary
        @rtype: unicode
        @return: msg display html
        """
        _ = self.request.getText
        msgs = d['msg']

        result = u""
+       sticky = True # added stickiness for messages that cannot be cleared [IanRiley 06.01.19]
        close = d['page'].link_to(self.request, text=_('Clear message'), css_class="clear-link")
        for msg, msg_class in msgs:
+           if msg_class[0] != '!': # leading '!' means a sticky message
+              sticky = False       # so at least one msg is non-sticky
+           else:
+              msg_class = msg_class.replace('!', '', 1) # remove leading '!'
            try:
                result += u'<p>%s</p>' % msg.render()
                close = ''
            except AttributeError:
                if msg and msg_class:
                    result += u'<p><div class="%s">%s</div></p>' % (msg_class, msg)
                elif msg:
                    result += u'<p>%s</p>\n' % msg
        if result:
-           html = result + close
+           html = result 
+           if not sticky: # only add close when at least one msg is non-sticky
+               html = result + close
            return u'<div id="message">\n%s\n</div>\n' % html
        else:
            return u''

        return u'<div id="message">\n%s\n</div>\n' % html

}}}

To make a message sticky, an exclamation mark has to be added to the front of the message in the code generating the message. This suffix is removed before the message is displayed.

If preferred, the `msg` function of the `ThememBase` could be overridden it `wiki.data.plugin.theme`, rather in the main code.

-----

 Hits:: <<Hits>>