Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 239 lines (173 sloc) 9.757 kB
e37126e @punchagan Improved README
authored
1 #+TITLE: Org2blog Readme
2 #+Options: num:nil
f425a88 @punchagan Minor changes.
authored
3 #+STARTUP: odd
e37126e @punchagan Improved README
authored
4 #+Style: <style> h1,h2,h3 {font-family: arial, helvetica, sans-serif} </style>
5
2d76300 @punchagan Add README
authored
6 * Overview
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
7 org2blog/wp is a tool to publish directly from Emacs' org-mode to
8 [[http://wordpress.org/][WordPress]] blogs. org2blog/wp is one of the two packages named
9 org2blog. The other is [[http://repo.or.cz/r/org2blog.git/][org2blog/atom]] by [[http://tehom-blog.blogspot.com/][Tom Breton]].
2d76300 @punchagan Add README
authored
10
eb55886 @punchagan Add information about support for other weblog engines
authored
11 org2blog/wp should, /ideally/, work with any platform that supports
12 xml-rpc but some of wordpress specific features may not work.
13
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
14 org2blog was inspired by and based on a [[http://paste.lisp.org/display/69993][wordpress posting client for
874fda4 @punchagan Minor changes to README.
authored
15 muse-mode]] written by [[http://www.emacswiki.org/emacs/AshishShukla][Ashish Shukla]].
c174c04 @punchagan Add License and links for abbe's code in README
authored
16
17 org2blog is licensed under GPLv3
18
2d76300 @punchagan Add README
authored
19 * Installation
20
874fda4 @punchagan Minor changes to README.
authored
21 Download org2blog from github
2d76300 @punchagan Add README
authored
22
23 : git clone http://github.com/punchagan/org2blog.git
24
25 Add the org2blog directory to your load path and then add
26
e37126e @punchagan Improved README
authored
27 : (setq load-path (cons "~/.emacs.d/org2blog/" load-path))
8116c1a @manandbytes Update installation instructions
manandbytes authored
28 : (require 'org2blog-autoloads)
2d76300 @punchagan Add README
authored
29
7e3be1e @punchagan Minor Fixes.
authored
30 to your dot emacs.
31
f425a88 @punchagan Minor changes.
authored
32 *** Dependencies
7a6afae @punchagan Add comment about using latest org-mode.
authored
33 1. org2blog depends on /xml-rpc/ available at [[http://launchpad.net/xml-rpc-el][Launchpad]]. Add it
34 to your /load-path/ before using org2blog.
35
36 2. Make sure you have the latest org-mode installed. org2blog may
37 not work with older versions of org.
11c256c @mrvdb Changing README.org to be in sync with new org2blog-blog-alist
mrvdb authored
38
e37126e @punchagan Improved README
authored
39 * Usage
f425a88 @punchagan Minor changes.
authored
40 *** Defining your blog setup
33ed283 @punchagan Changed version to 0.3, added a note in README about changes.
authored
41
42 *Note* - This setup works only for org2blog version >=0.3. For
6c4aa06 @punchagan README improvements.
authored
43 lower versions of org2blog check the README from the commit
44 e37126e
33ed283 @punchagan Changed version to 0.3, added a note in README about changes.
authored
45
11c256c @mrvdb Changing README.org to be in sync with new org2blog-blog-alist
mrvdb authored
46 You can (should) tell org2blog where your blogs are and optionally
47 specify different values for some options. This is done by
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
48 customising the variable =org2blog/wp-blog-alist=.
f425a88 @punchagan Minor changes.
authored
49
11c256c @mrvdb Changing README.org to be in sync with new org2blog-blog-alist
mrvdb authored
50 For example:
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
51 : (setq org2blog/wp-blog-alist
e9dee4d @punchagan Changed README to reflect the org2blog-blog-alist changes.
authored
52 : '(("wordpress"
53 : :url "http://username.wordpress.com/xmlrpc.php"
54 : :username "username"
55 : :default-title "Hello World"
56 : :default-categories ("org2blog" "emacs")
57 : :tags-as-categories nil)
58 : ("my-blog"
59 : :url "http://username.server.com/xmlrpc.php"
60 : :username "admin")))
f425a88 @punchagan Minor changes.
authored
61
11c256c @mrvdb Changing README.org to be in sync with new org2blog-blog-alist
mrvdb authored
62 This defines two blogs identified by the terms =wordpress= and
6c4aa06 @punchagan README improvements.
authored
63 =my-blog=.
64
65 The variables in the =plist= set for each blog over-ride the
66 global values of the corresponding variables. =url= and =username=
67 are mandatory variables. Others are optional. If you customize the
68 variable =org2blog/wp-blog-alist= there is detail information about the
69 meaning of each property.
40a0910 @punchagan Issue 33: Add rudimentary support to for using netrc
authored
70
71 You can also use =.netrc= file to save your usernames and
72 passwords.
73
74 Your =.netrc= should look like this
75
76 : machine myblog login myusername password myrealpassword
77
78 Then, use these details, as shown below.
11c256c @mrvdb Changing README.org to be in sync with new org2blog-blog-alist
mrvdb authored
79
40a0910 @punchagan Issue 33: Add rudimentary support to for using netrc
authored
80 : (setq blog (netrc-machine (netrc-parse "~/.netrc") "myblog" t))
81 : (setq org2blog/wp-blog-alist
82 : '(("my-blog"
83 : :url "http://username.server.com/xmlrpc.php"
84 : :username (netrc-get blog "login")
85 : :password (netrc-get blog "password"))))
86
e9dee4d @punchagan Changed README to reflect the org2blog-blog-alist changes.
authored
87
f425a88 @punchagan Minor changes.
authored
88 To browse or customize other variables use the customize group
89 function.
7e3be1e @punchagan Minor Fixes.
authored
90
628a8e1 @punchagan Add FAQ to README.
authored
91 : M-x customize-group org2blog/wp RET
7e3be1e @punchagan Minor Fixes.
authored
92
f425a88 @punchagan Minor changes.
authored
93 *** Logging In
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
94 Use *M-x org2blog/wp-login*. This function ask you for the name of one
95 of the blogs you have configured in the org2blog/wp-blog-alist
11c256c @mrvdb Changing README.org to be in sync with new org2blog-blog-alist
mrvdb authored
96 variable described above and will ask for your password. The
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
97 counterpart of this function is *M-x org2blog/wp-logout*, which will
11c256c @mrvdb Changing README.org to be in sync with new org2blog-blog-alist
mrvdb authored
98 log you out of the active blog.
0930e68 @punchagan README updated with issue about wpautop in Wordpress.
authored
99
f425a88 @punchagan Minor changes.
authored
100 *** Writing a new post
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
101 Use *M-x org2blog/wp-new-entry*.
f425a88 @punchagan Minor changes.
authored
102 - Tags and Categories are comma or space separated values.
103 Completion (for both) is triggered using *C-c t*. If a new
104 category is used you will be prompted before adding it.
105 - The excerpt for a post can be written as =#+DESCRIPTION=.
63a7af7 @punchagan Fix Issue 44: Allow to set permalinks
authored
106 - The Permalink of a post can be set using =#+PERMALINK=.
6c4aa06 @punchagan README improvements.
authored
107 - The parent for a page can be specified using =#+PARENT=. *C-c
f425a88 @punchagan Minor changes.
authored
108 t* again provides completion for the page name.
109
110 *** Publishing
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
111 | post buffer as draft | *C-c d* | *M-x org2blog/wp-post-buffer* |
112 | publish buffer | *C-c p* | *C-u M-x org2blog/wp-post-buffer* |
113 | post buffer as page draft | *C-c D* | *M-x org2blog/wp-post-buffer-as-page* |
114 | publish buffer as page | *C-c P* | *C-u M-x org2blog/wp-post-buffer-as-page* |
f425a88 @punchagan Minor changes.
authored
115
116 *** Post your existing org-files too
117 - Add =#+TITLE=, =#+OPTIONS=, =#+TAGS=, =#+CATEGORY=,
118 =#+DESCRIPTION=, =#+DATE=, to your file. (All of these are
119 Optional)
120 - Add a =#+POSTID= to edit an existing post.
121 - Post buffer using the function names, as above.
122
123 *** Posting a subtree
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
124 - Use *M-x org2blog/wp-post-subtree*.
6c4aa06 @punchagan README improvements.
authored
125 - Tags of the subtree will be used for tags.
126 - Other properties can be set using a property drawer. The
127 properties use the same names as the buffer variables.
128 - =POST_DATE= sets the date to be used for the post. If it is not
129 present, =SCHEDULED=, =DEADLINE= or any other active or inactive
130 time-stamps are used.
131 - The headline is used as the title of the post. But, =TITLE= can
132 be used to use a different title.
f425a88 @punchagan Minor changes.
authored
133 *** Delete an entry or a page
134 - If you are in the buffer of the entry/page, with =#+POSTID=
6c4aa06 @punchagan README improvements.
authored
135 present on the page, use:
136
137 *M-x org2blog/wp-delete-entry* or *M-x org2blog/wp-delete-page*
138
139 - If you want to delete a particular post (whose post-id is known)
140 from any buffer, use
141
142 *C-u post-id M-x org2blog/wp-delete-entry*.
f425a88 @punchagan Minor changes.
authored
143
144 Similarly, for a page.
145
146 *** Enabling org2blog mode (defines key-bindings)
a014736 @punchagan Change README.org to reflect the change in namespace.
authored
147 - use *M-x org2blog/wp-mode*.
f425a88 @punchagan Minor changes.
authored
148 This defines the following the key-bindings:
149 | *C-c p* | publish buffer |
150 | *C-c d* | post as draft |
151 | *C-c t* | complete tag or parent page name |
b926226 @punchagan Add documentation for creating new page and deletion of entry/page.
authored
152
9180cfc @punchagan Added documentation about image upload to README.
authored
153 *** Uploading Images
154 In-line images and linked images with file:// urls (e.g.,
2bbf513 @punchagan Minor fix to images documentation.
authored
155 ~[[file:///path.to.jpeg]]~ or ~[[file:///path.to.jpeg][this is an image link]]~ will be uploaded to
9180cfc @punchagan Added documentation about image upload to README.
authored
156 the media library and the links will be updated. Captions and
157 attributes as [[http://orgmode.org/manual/Images-in-HTML-export.html][defined]] in org-mode will be preserved, but at
158 present these attributes are not saved with the image to the
159 library itself. [Information about uploaded files are added as a
160 comment to the post itself, to prevent repeated uploads, but this
161 isn't as stable as I would like it.]
162
8c2d657 @punchagan Minor edits.
authored
163 * Miscellaneous
4a0ce5a @punchagan Minor Changes.
authored
164 1. You may want to look at the [[http://orgmode.org/manual/Export-options.html#Export-options][Export options]] and [[http://orgmode.org/manual/HTML-export.html#HTML-export][HTML export]]
165 sections of the org-manual.
874fda4 @punchagan Minor changes to README.
authored
166
2eb924f @punchagan Update README.
authored
167 2. If you wish to post to blogger from org-mode, look at -
168
900f92d @punchagan Change list of alternative software to a numbered list
authored
169 1. [[http://repo.or.cz/r/org2blog.git/][org2blog/atom]], a g-client extension by [[http://tehom-blog.blogspot.com/][Tom Breton]]
170
171 2. [[http://github.com/rileyrg/org-googlecl][org-googlecl]] by Richard Riley -- uses [[http://code.google.com/p/googlecl/][googlecl]]
874fda4 @punchagan Minor changes to README.
authored
172
aa76d0e @punchagan Add contact details to README.
authored
173 3. If you have an issue/bug/feature request, use the issue tracker
174 on git or drop a mail to punchagan+org2blog[at]gmail[dot]com.
874fda4 @punchagan Minor changes to README.
authored
175
aa76d0e @punchagan Add contact details to README.
authored
176 4. If you haven't found a bug/issue, but have tried out and/or are
177 using org2blog to post to your blog, post me a line on how you
178 use it and on what blog. I'd love to hear from you!
d245f0f @punchagan Added comment about listing site in github wiki.
authored
179
180 5. Now, that org2blog does have a bunch of users, I'd like to keep
181 track of the blogs it's being used on. :) Feel free to add your
cf5ec46 @punchagan Added link to wiki.
authored
182 site to the list of sites using org2blog, on the [[https://github.com/punchagan/org2blog/wiki/Blogs-using-org2blog][wiki]] at github.
eb55886 @punchagan Add information about support for other weblog engines
authored
183
184 6. The [[http://www.doclear.net/][Dotclear]] weblog engine [[https://github.com/punchagan/org2blog/issues/issue/37][also works]] with org2blog
aa76d0e @punchagan Add contact details to README.
authored
185
628a8e1 @punchagan Add FAQ to README.
authored
186 * FAQ
187 - How many blogs can I configure with org2blog?
188
189 You can configure and use any number of blogs with org2blog/wp.
190 Use the ~org2blog/wp-blog-alist~ variable to configure each blog.
191 Look at the [[Defining your blog setup]] section, in the README. But,
192 note that you can be logged in, to just one blog at a time.
193
194 - How do I change the default title of a new post?
195
196 : (setq org2blog/wp-default-title "My New Title")
197
198 - How do I change the default title for one blog alone?
199
200 Set the relevant (~:default-title~) variable in the
201 ~org2blog/wp-blog-alist~ variable.
202
203 - I donot use tags. I wish to use them as categories. How?
204
205 Setting the ~org2blog/wp-use-tags-as-categories~ variable will do
206 that for all the blogs.
207
208 : (setq org2blog/wp-use-tags-as-categories t)
209
210 Instead, you can set the corresponding variable for each blog that
211 you are using.
212
213 - Can I configure org2blog to confirm before publishing a post?
214
215 : (setq org2blog/wp-confirm-post t)
216
217 - I wish to customize the default template of a new post. How do I
218 do it?
219
220 Customize the variable =org2blog/wp-buffer-template=.
221
222 - New-lines are not handled properly. Why?
223
224 The behaviour of new-lines has been working since a little before
225 version 0.3. It is highly recommended that you use the latest git
226 version of org2blog.
227
228 By default, new lines are stripped off from the org buffer. To
229 retain new-lines, unset the =org2blog/wp-keep-new-lines=
230 variable.
231
232 - Why aren't my SRC blocks not enclosed in =[sourcecode]
233 [/sourcecode]= block?
695ff69 @punchagan Add newlines at the end of README.org
authored
234
628a8e1 @punchagan Add FAQ to README.
authored
235 Set the =org2blog/wp-use-sourcecode-shortcode= variable to turn on
236 this behaviour. You may also set it at a per-blog level, if you
237 choose.
695ff69 @punchagan Add newlines at the end of README.org
authored
238
Something went wrong with that request. Please try again.