---

Ⅰ. 插件描述

create comment string for overleaf

Ⅱ. 基本信息

创建日期：  2018-02-19 使用用户：  1 Github星：  1 插件作者：  pseyfert

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'pseyfert/overleaf-commenter'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'pseyfert/overleaf-commenter'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'pseyfert/overleaf-commenter'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/pseyfert/overleaf-commenter

Ⅳ. 文档说明

overleaf-commenter

Use Overleaf discussions on a local text editor.

background

Overleaf is a cloud based collaborative latex editing tool. (I.e. have a
tex(t) editor in the web browser, automatically re-generate the pdf on the
server and show it in the browser). It's a bit a multi-user compiler-explorer
for TeX.

Discussions on Overleaf are kept in the document (and thus accessible through
the git clone) as tex comments.

The syntax is (simply by looking at what gets generated):

Some regular $T=e \cdot X$ code.

% * <email@server.tld> 2018-02-05T14:56:52.585Z:
% 
% I would phrase this similar ...
% 
% ^ <other.email@server.tld> 2018-02-12T14:05:57.936Z:
% 
% I agree, I just wanted to make it clear that I think this is a very hard problem.
% 
% ^.

I.e. % * starts a discussion % ^. ends it, and % ^ is a response.

Overleaf documents can be accessed through git. One can follow and contribute
to discussions from a local text editor, provided one gets the syntax right -
something your computer should be able to do for you in your local text editor.

USAGE

as vim plugin

Simply call

:OverleafComment

or

:OverleafCloseDiscussion

(see below for install suggestions)

overleaf-commenter can be called from the command line:

> python overleaf_comment.py

% *^ <email@server.tld> 2018-02-21T07:31:12.752395Z:
%
% WRITEME
%
% ^.

You then should pick ^ or * and write the comment. python may be python2
or python3.

overleaf_comment.py has the command line option --close to generate the
string that closes a discussion.

overleaf-commenter can be called manually from vim

You can also manually do what the vim plugin does.

To insert a comment call

:py3f /path/to/overleaf-commenter/overleaf_comment.py

NB: depending on the python support of your vim installation, try pyf instead of py3f.

The vim functionality has a bit of heuristics to determine if a reply is
requested or a new comment will be started. The comment will be inserted
between the current cursor's line and the next line. The distinction is based
on the current line (comparison to $ ^.).

When the cursor is on the ending line of a discussion, one can as well close a discussion:

py3 import sys
py3 sys.argv.append("--close")
py3f /path/to/overleaf-commenter/overleaf_comment.py
py3 sys.argv.pop()

This mimics the CLI call with --close. It will print an error when the cursor
is not on the ending line of a discussion.

INSTALL

Just use your favourite internet search engine to figure out how you want to manage vim plugins. It may boil down to:

• (pathogen)

cd ~/.vim/bundle
git clone https://github.com/pseyfert/overleaf-commenter

• (vundle)

Plugin 'pseyfert/overleaf-commenter'

What can/can't go into the comment syntax

Trying around:

• microseconds (as in ISO8601 formaters) are allowed
• the time is not checked for "validity" (future postings are okay)
• the time is UTC
• time zone information is not allowed (the comment will not be picked up as discussion
• email addresses which do not correspond to overleaf accounts are valid (though no avatar and author information will get rendered)

Behind the scenes

• overleaf-commenter obtains the email address through git. (Since the git commit email address and the account on overleaf are independent, this might actually be wrong)