Vim documentation: StatuslineUpdateTimer

StatuslineUpdateTimer.txt     a summary

Version : Eternal beta 1
Author  : Tsuyoshi CHO <Tsuyoshi.CHO+develop@Gmail.com>
License : MIT license  {{{
    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files (the
    "Software"), to deal in the Software without restriction, including
    without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to
    permit persons to whom the Software is furnished to do so, subject to
    the following conditions:
    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
}}}

==============================================================================
CONTENTS                                        StatuslineUpdateTimer-contents

INTRODUCTION                    StatuslineUpdateTimer-introduction
USAGE                           StatuslineUpdateTimer-usage
INTERFACE                       StatuslineUpdateTimer-interface
  VARIABLES                       StatuslineUpdateTimer-variables
  COMMANDS                        StatuslineUpdateTimer-commands
  FUNCTIONS                       StatuslineUpdateTimer-functions
TODO                            StatuslineUpdateTimer-todo
CHANGELOG                       StatuslineUpdateTimer-changelog


==============================================================================
INTRODUCTION                                    StatuslineUpdateTimer-introduction

StatuslineUpdateTimer is a vim statusline periodic update plugin.

Latest version:
https://github.com/tsuyoshicho/StatuslineUpdateTimer.vim


==============================================================================
USAGE                                           StatuslineUpdateTimer-usage

Install via vim or plugin manager.
Vim statusline is updated automatically.


==============================================================================
INTERFACE                                       StatuslineUpdateTimer-interface

------------------------------------------------------------------------------
VARIABLES                                       StatuslineUpdateTimer-variables

                                                g:StatuslineUpdateTimer#enable
g:StatuslineUpdateTimer#enable
        default value: 1
        Plugin enable flag, if you need disable set as 0.
        Set as before plugin load.

                                                g:StatuslineUpdateTimer#updatetime
g:StatuslineUpdateTimer#updatetime
        default value: &updatetime
        Timer update interval, same as updatetime's unit.

                                                g:StatuslineUpdateTimer#adjust_minute
g:StatuslineUpdateTimer#adjust_minute
        default value: 0
        Timer update interval adjust to fire at next minute+1sec.
        When this is enabled, no affect g:StatuslineUpdateTimer#updatetime.

                                                g:StatuslineUpdateTimer#interval_function
g:StatuslineUpdateTimer#interval_function
        default value: (internal function)
        Periodic interval called function.
        Default function call redrawstatus!.
        May set as custom function.

                                                g:StatuslineUpdateTimer#clockformat
g:StatuslineUpdateTimer#clockformat
        default value: "%m/%d(%a) %H:%M"
        Utility function format(strftime style).


------------------------------------------------------------------------------
COMMANDS                                        StatuslineUpdateTimer-commands

                                                StatuslineUpdateStart
StatuslineUpdateStart
        Timer start command.
        When g:StatuslineUpdateTimer#enable are disabled, ignore and start.
        Timer do not sotpped, but no side-effect.

                                                StatuslineUpdateStop
StatuslineUpdateStop
        Timer stop command.
        Timer do not started, but no side-effect.


------------------------------------------------------------------------------
FUNCTIONS                                       StatuslineUpdateTimer-functions

                                                StatuslineUpdateTimer#clock()
StatuslineUpdateTimer#clock()
        Utility function, Usage at displaying time to statusline.
        Define format at g:StatuslineUpdateTimer#clockformat.
        return: formatted time string.

                                                StatuslineUpdateTimer#emoji_clock()
StatuslineUpdateTimer#emoji_clock()
        Utility function, Usage at displaying emoji clock to statusline.
        return: Current time's emoji of the 12-hour.


==============================================================================
TODO                                            StatuslineUpdateTimer-todo

- Buffer refreshed by timer. As a result, opening splash-string,multiline
  message disappears at refreshed time.
  Currently there are no workarounds which seems to be the operation specification of vim.


==============================================================================
CHANGELOG                                       StatuslineUpdateTimer-changelog

Eternal beta 5
        Fix problem and add emoji clock.

Eternal beta 4
        Simplify.

Eternal beta 3
        Split adjuster feature in interval calc.
        Add start/stop commands.

Eternal beta 2
        Add adjuster feature.

Eternal beta 1
        Initial implementation.


==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet:fen: