---

Ⅰ. 插件描述

A logbook for software engineers

Ⅱ. 基本信息

创建日期：  2015-10-16 使用用户：  1 Github星：  2 插件作者：  Michael Avila

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'michaelavila/vim-logbook'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'michaelavila/vim-logbook'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'michaelavila/vim-logbook'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/michaelavila/vim-logbook

Ⅳ. 文档说明

logbook

A logbook for software engineers.

Let's loosely define a logbook as:

A record of important events.

1. Install using your method of choice: michaelavila/vim-logbook
2. Create the logbook directory: mkdir $HOME/.logbook
3. Map the two logbook functions to the keyboard:

nnoremap <leader>le :call LogbookNewEntry()<cr>
nnoremap <leader>ld :call LogbookSignEntry()<cr>
nnoremap <leader>ll :call LogbookListEntries()<cr>

why?

Your logbook is where you record important events. The length and detail of your entries will vary. Routine tasks might take just a sentence or two while larger tasks can take up to several pages. Learning when to be brief and when to spell out an entry in detail is a skill that, like any other, will take time to acquire. Here are some of the many great reasons (so-called prompts) to write an entry in your logbook:

• planning work
• working problems
• recording events
• "discussing" results (with yourself)
• checking progress
• revewing literature
• learning new tools and processes
• highlighting things you don't understand
• describing ideas
• tracking hours (if you're into that kind of thing)
• etc

This content will become your meetings, emails, commit messages, tools, blog posts, essays, books, and countless other things you generate from your hard-won information. Throughout the day, your logbook will provide two valuable benefits:

1. To help you not forget (obvious)
2. To free up your mind (not obvious)

The moment you've written something down in a safe place, you've decreased your chances of losing that information. The peace of mind that comes with increasing the likelihood that you'll take care of the things you've written down will free up your mind to focus more attention on the probems in front of you.

how it works

All log entries are stored in $HOME/.logbook. Each entry is a plain text file
named using the timestamp of the moment the entry was started. The
LogbookEditNewEntry function will create this file for you. The
LogbookListEntries function will populate vim's quickfix list with all of the
entries in your logbook. You can use the quickfix commands to navigate the
entries.