vim 日历插插 calendar 2.9帮助文档

calendar.txt vim 中的日历工具

作者:  Yasuhiro Matsumoto <mattn.jp@gmail.com>

介绍                                    calendar

这个脚本可以在 vim 中创建一个日历窗口。它不需要如 cal 之类的外部程序。

命令                                        calendar-commands

calendar.vim 可用的命今如下：

                                                calendar-:Calendar
:Calendar [[year] month]  在一个垂直窗口下显示指定的年份与月份日历。
                          当 [year] 被省略时则默认为当前年份。
                          当 [year] 和 [month] 都省略时默认为当月。

                                                calendar-:CalendarH
:CalendarH [[year] month] 在一个水平窗口下显示指定的年份与月份日历。
                          当 [year] 被省略时则默认为当前年份。
                          当 [year] 和 [month] 都省略时默认为当月。

                                                calendar-:CalendarT
:CalendarT [[year] month] 全屏显示指定的年份与月份日历。
                          当 [year] 被省略时则默认为当前年份。
                          当 [year] 和 [month] 都省略时默认为当月。

                                                calendar-:CalendarVR
:CalendarVR [[year] month]  在右边分出一个垂直窗口来显示指定的年份与月份。
                          当 [year] 被省略时则默认为当前年份。
                          当 [year] 和 [month] 都省略时默认为当月。

                                            calendar-:CalendarSearch
:CalendarSearch [keyword]  在当前的日历里进行搜索。


映射                                        calendar-mappings

calendar.vim 在 normal 模式下有下面这些映射：

                                                calendar-cal
<LocalLeader>cal          在垂直窗口下显示日历。
                          相当于 :Calendar.

                                                calendar-caL
<LocalLeader>caL          在水平窗口下显示日历。
                          相当于 :CalendarH.

设置                                        calendar-settings

calendar.vim 可以通过下面的这些设置进行配置：

                                                g:calendar_no_mappings
禁用标准映射：
  let g:calendar_no_mappings=0

                                                g:calendar_focus_today
在向前或向后查看日历时保持焦点不变：
  let g:calendar_focus_today = 1
<

                                                g:calendar_keys
修改日历下按键的映射，请在目录下找到对应的值进行修改。日历中按键的映射
以及对应的功能如下。
'close'                     关闭日历窗口            'q'
'do_action'                 执行 calendar_action.   '<CR>'
'goto_today'                执行 calendar_today.    't'
'show_help'                 显示一份简短的帮助信息  '?'
'redisplay'                 重新绘制日历窗口        'r'
'goto_next_month'           跳转到下个月            '<Right>'
'goto_prev_month'           跳转到上个月            '<Left>'
'goto_next_year'            跳转到下一年            '<Down>'
'goto_prev_year'            跳转到上一年            '<Up>'
在 .vimrc 文件中你可以像下面这样来修改对应的按键：
  let g:calendar_keys = { 'goto_next_month': '<C-Right>', 'goto_prev_month': '<C-Left>'}


                                                g:calendar_mark
在当前日期后面标记 '*' 或 '+' 来做标记。可以设置为 'left', 'left-git',
或者 'right'：
  let g:calendar_mark = 'right'


                                                g:calendar_diary
指定日记文件的存放目录，默认值是 $HOME/diary。
  let g:calendar_diary=$HOME.'/.vim/diary'


                                           g:calendar_diary_list
配置多篇日记。
  let g:calendar_diary_list = [
    \   {'name': 'Note', 'path': $HOME.'/note', 'ext': '.md'},
    \   {'name': 'Diary', 'path': $HOME.'/diary', 'ext': '.diary.md'},
    \ ]


                                  g:calendar_diary_list_curr_idx
指定多篇日记的配置。默认值是 0。
  let g:calendar_diary_list_curr_idx = 1



                                                g:calendar_navi
对日历中的导航位置进行控制。可以道择 'top', 'bottom', 或 'both'。
  let g:calendar_navi = ''


                                                g:calendar_navi_label
设置日历导航显示的文字，他们之间以半角的逗号相隔。
  let g:calendar_navi_label = 'Prev,Today,Next'


                                                g:calendar_erafmt
修改日历的体系修改这个选项的值。可修改的项有日历名字和新日历体系与西历的差值。
如要使用当前日本的日历体系 (Heisei) 可以这样进行设置：
  let g:calendar_erafmt = 'Heisei,-1988'


                                                g:calendar_mruler
修改月份的名字修改这个选项，值为从一月开始到十二月结束，十二个值以英文逗号分
隔开：
  let g:calendar_mruler = 'Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec'


                                                g:calendar_wruler
修改星期的名称修改这个选项，值从星期一到星期日，七个值以英文逗号分隔开：
  let g:calendar_wruler = 'Su Mo Tu We Th Fr Sa'


                                                g:calendar_monday
设置一周的开始时间为星期一，而不是星期日。注意 g:calendar_wruler 的值不受
这个选项的影响，它应该总是星期日：
  let g:calendar_monday = 1


                                                g:calendar_weeknm
显示周数，它有以下五种可用的
  let g:calendar_weeknm = 1 " WK01
  let g:calendar_weeknm = 2 " WK 1
  let g:calendar_weeknm = 3 " KW01
  let g:calendar_weeknm = 4 " KW 1
  let g:calendar_weeknm = 5 " 1


                                                g:calendar_datetime
在页面显示当前日期时间，可设置为 'title', 'statusline', 和 ''：
  let g:calendar_datetime = 'title'

                                                g:calendar_filetype
设置日历文件的类型，默认为 'markdown' 类型。filetype 可设置为 'markdown' 或
'pandoc'：
  let g:calendar_filetype = 'pandoc'

                                                g:calendar_number_of_months
控制视窗中显示几个月的视图，默认显示三中月的视图。
  let g:calendar_number_of_months = 5


                                                g:calendar_search_grepprg
为命令 :CalendarSearch 配置搜索程序。默认使用系统的 'grep' 程序，如果你想
使用 vim 中的 :vimgrep 程序，那么将值设置为 'internal'。
  let g:calendar_search_grepprg = 'internal'


钩子                                           calendar-hooks

calendar.vim 提供了一些钩子，它可以让你在进行某些操作时执行自定义的代码。这
些钩子如下。

                                                calendar_action
calendar_action 中定义的代码在光标处于日历中日期上时按下回车键执行。可以按
照下面的方式进行设置：
  function MyCalAction(day,month,year,week,dir)
    " day   : 你想让其执行的那天
    " month : 你想让其执行的那月
    " year  : 你想让其执行的那年
    " week  : 星期几 (Mo=1 ... Su=7)
    " dir   : 日历所在的目录
  endfunction
  let calendar_action = 'MyCalAction'


                                                calendar_begin
calendar_begin 中定义的代码在显示日历窗口前执行，可以按照下面的方式进行设置：
  function MyCalActionBegin()
  endfunction
  let calendar_begin = 'MyCalActionBegin'


                                                calendar_end
calendar_end 中定义的代码在显示日历窗口显示后立即执行，可以按照下面的方式
进行设置：
  function MyCalActionEnd()
  endfunction
  let calendar_end = 'MyCalActionEnd'


                                                calendar_sign
calendar_sign 中定义的代码用于在指定的日期旁做标记，可以按照下面的方式进行
设置：
  function MyCalSign(day,month,year)
    " day   : 你要做标记的天
    " month : 你要做标记的月
    " year  : 你要做标记的年
    if a:day == 1 && a:month == 1
      return 1 " happy new year
    else
      return 0 " or not
    endif
  endfunction
  let calendar_sign = 'MyCalSign'


                                                calendar_today
calendar_today 中定义的代码在按下 'today' 时执行，可以按照下面的方式进行
设置：
  function MyCalToday()
  endfunction
  let calendar_today = 'MyCalToday'


关于                                           calendar-about

从 GitHub 下载 calendar.vim 地址：

  http://github.com/mattn/calendar-vim

也可以从 VimScripts 下载（注：该版本为老版本）：

  http://www.vim.org/scripts/script.php?script_id=52

vim:tw=78:et:ft=help:norl: