VimRepress/doc/vimpress.txt at 0355e96fafdedbbda15821feb2a758809a7c846e · vim-scripts/VimRepress · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
*vimpress.txt*   Plugin for managing wordpress blog from Vim.

Script:   blog.vim
Authors:  Adrien Friggeri <mailto:adrien@friggeri.net>
          Pigeond <http://pigeond.net/blog/>
          * Preston M.[BOYPT] <mailto:pentie@gmail.com>
          Justin Sattery <mailto:justin.slattery@fzysqr.com>
          Lenin Lee <mailto:lenin.lee@gmail.com>
          * Conner McDaniel <mailto:connermcd@gmail.com>
    (* Currently developing)
    Conner's Repository: https://github.com/connermcd/VimRepress
    Preston's Repository: https://bitbucket.org/pentie/vimrepress

License:  Same terms as Vim itself (see |license|)

============================================================================

*INSTALL*

Download vimpress_x.x.x.zip, extract it in your .vim directory:

  cd ~/.vim
  unzip /path/to/vimpress_x.x.x.zip

*CONFIGURE*

Create file `~/.vimpressrc' in the following format:

    [Blog0]
    blog_url = http://a-blog.com/
    username = admin
    password = 123456

    [Blog1]
    blog_url = https://someone.wordpress.com/
    username = someone
    password =

>
For Upgraded Users:

    Defining Account info in `.vimrc` is now obsolesced, if you have correspond defination in `.vimrc', they will automaticly copied into `~/.vimpressrc', now you're safe to remove the VIMPRESS defination in `.vimrc'.
<

Hardcoding the password is optional. If a password is not provided,
the plugin will prompt for one the first time it's needed.

If you need Markdown support, simply run `sudo apt-get install python-markdown' in Ubuntu.

If you use other distributions (or OSs), refer to your package manager or the python-markdown
project page: http://www.freewisdom.org/projects/python-markdown/Installation

*COMMANDS*

Vimpress Commands (parameters in square brackets are optional):
>
    :BlogList [<edit_type>] [<count>]
<   Lists a specified number of blog posts or pages for the current blog
    starting the with most recent.  In this view, you can press <enter>
    to open a post for edit, or press <delete> to move a post to trash.
    The Delete function doesn't actually remove your post, but move to
    the trash.
    [<edit_type>] - either post or page, [Default post].
    [<count>]  - number to display (only for posts, Default 30)
>
    :BlogNew [<edit_type>]
<   Creates a new page editing window from the current buffer.
    [<edit_type>] - either post or page. [Default:post]
>
    :BlogSave [<save_type>]
<   Saves the current editing window.
    [<save_type>] - either post or publish. [Default:draft]
>
    :BlogPreview [<save_type>]
<   If set to local, converts the editing window to HTML and displays it
    locally in a file browser. Otherwise, the command is the same as
    :BlogSave except that it opens a preview of the post or page on the blog.
    [<save_type>] - either local, post, or publish. [Default:local]
>
    :BlogOpen <post-link-or-id>
<   Opens the specified post.
    <post-link-or-id> - link you copied from the browser, or simply the
                        numberic post id.
>
    :BlogSwitch [<index>]
<   Switches the current working blog to the next in the configuration
    array or the specified index.
    [<index>]   - index of blog to switch to.
>
    :BlogUpload <file>
<   Uploads a file to the blog's media library, then the attachment URL
    will append to the current buffer.
     <file>     - /path/to/file
>
    :BlogCode [<language>]
<   Appends a pre tag to the end of the current buffer of a specified
    code language. (i.e. python)
     [<language>] - the coding language

*TIPS*

|Categories| When you're writing a new post, and you want to fill the "Cats"
line in the meta field, press <Ctrl-x Ctrl-u> in INSERT mode, a menu will
show up with all your categories names in your blog. Completion is supported.

|Recovery| If you have a slow connection to your blog, there's a chance that gvim will got hanged during your posting the article, just wait patiently. If still vim crashed with fail posting your article (never happened here), don't  worried, vim had a inteligent recovery system, reopen vim and strike |:recovery| command, your article should appear. Type |:help recovery| for more info.


*EXAMPLES*

Some commands list above contain special usage, example below may clearify them for you.

>
    :BlogList             -  List 30 recent posts.
    :BlogList page        -  List 30 recent pages.
    :BlogList post 100    -  List 100 recent posts.

    :BlogNew post         -  Write an new post.
    :BlogNew page         -  Write an new page.

    :BlogSave             -  Save (defautely published.)
    :BlogSave draft       -  Save as draft.

    :BlogPreview local    -  Preview page/post locally in your browser.
    :BlogPreview publish  -  Same as `:BlogSave publish' with brower opened.

    :BlogOpen 679
    :BlogOpen http://your-first-blog.com/archives/679
    :BlogOpen http://your-second-blog.com/?p=679
    :BlogOpen http://your-third-blog.com/with-your-custom-permalink
<