/
org-readme.info
394 lines (260 loc) · 12 KB
/
org-readme.info
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
This is org-readme.info, produced by makeinfo version 4.13 from
org-readme.texi.
INFO-DIR-SECTION Emacs lisp libraries
START-INFO-DIR-ENTRY
* org-readme: (org-readme). Integrate Readme.org and Commentary/Change Logs.
END-INFO-DIR-ENTRY
File: org-readme.info, Node: Top, Next: Org Readme, Up: (dir)
Top
***
* Menu:
* Org Readme::
File: org-readme.info, Node: Org Readme, Prev: Top, Up: Top
1 Org Readme
************
Matthew L. Fidler ## Library Information _org-readme.el_ -- Integrates
Readme.org and Commentary/Change-logs.
* *Filename* - org-readme.el
* *Description* - Integrate Readme.org and Commentary/Change Logs.
* *Author* - Matthew L. Fidler
* *Maintainer* - Matthew L. Fidler
* *Created* - Fri Aug 3 22:33:41 2012 (-0500)
* *Version* - 0.34
* *Package-Requires* - ((http-post-simple "1.0") (yaoddmuse
"0.1.1")(header2 "21.0") (lib-requires "21.0"))
* *Last-Updated* - Wed Aug 22 13:11:26 2012 (-0500)
* *By* - Matthew L. Fidler
* *Update #* - 794
* *URL* - https:__github.com_mlf176f2_org-readme
* *Keywords* - Header2, Readme.org, Emacswiki, Git
* *Compatibility* - Tested with Emacs 24.1 on Windows.
* Menu:
* Possible Dependencies::
* Using org-readme::
* History::
File: org-readme.info, Node: Possible Dependencies, Next: Using org-readme, Up: Org Readme
1.1 Possible Dependencies
=========================
None
File: org-readme.info, Node: Using org-readme, Next: History, Prev: Possible Dependencies, Up: Org Readme
1.2 Using org-readme
====================
Org readme is used to:
* Create/Update a "History" section in the Readme.org based on the
changelog section of the Emacs Log.
* Create/Update a "Library Information" Section Based on the Emacs
lisp header.
* Create/Update a "Possible Dependencies" Section Based on the Emacs
lisp header.
* Create/Update a "Functions" Section based on the functions defined
in the single lisp library.
* Create/Update a "Variables" Section based on the variables defined
in the single lisp library.
All other sections of the Readme.org are then put into the "Commentary"
section of the readme.org.
In addition this library defines `org-readme-sync', a convenience
function that:
* Asks for a commentary about the library change.
* To exit/save press `C-c C-c'
* Asks if this is a minor revision
* If it is a minor revision, bumps the revision up so the new
library will be posted to marmalade-repo.org
* Syncs the Readme.org with the lisp file as described above.
* Updates emacswiki with the library description and the library
itself (requires yaoddmuse).
* Updates Marmalade-repo if the library version is different than
the version in the server (requires http-post-simple).
* Updates the git repository with the differences that you posted.
* If you are using github, this library creates a melpa recipie.
* If you are using github, this library creates a el-get recipie.
When `org-readme-sync' is called in a `Readme.org' file that is not a
single lisp file, the function exports the readme in EmacsWiki format
and posts it to the EmacsWiki. ### EmacsWiki Page Names EmacsWiki Page
names are generated from the file. `org-readme.el' would generate a
page of OrgReadme.
* Menu:
* Why each required library is needed::
File: org-readme.info, Node: Why each required library is needed, Up: Using org-readme
1.2.1 Why each required library is needed
-----------------------------------------
There are a few required libraries. This is a list of the require
libraries and why they are needed.
Library Why it is needed
yaoddmuse Publish to emacswiki Publish to
http-post-simple marmalade-repo.org To create header
header2 and changelog To generate the library
lib-requires dependencies
File: org-readme.info, Node: History, Prev: Using org-readme, Up: Org Readme
1.3 History
===========
* *07-Dec-2012* - Attempted to fix the package information file.
(Matthew L. Fidler)
* *07-Dec-2012* - Added tar package that includes the info file
(Matthew L. Fidler)
* *07-Dec-2012* - No longer deletes ilg files. (Matthew L. Fidler)
* *07-Dec-2012* - Bug fix for info generation. (Matthew L. Fidler)
* *07-Dec-2012* - Added mecahism to build info files and dir files
for elpa package. (Matthew L. Fidler)
* *07-Dec-2012* - Get description from info file. (Matthew L. Fidler)
* *07-Dec-2012* - The description should now be picked up. (Matthew
L. Fidler)
* *07-Dec-2012* - Attempting to update description. (Matthew L.
Fidler)
* *07-Dec-2012* - Test directory entry (Matthew L. Fidler)
* *07-Dec-2012* - Added directory entry to texinfo file. (Matthew L.
Fidler)
* *18-Sep-2012* - Bug fix to allow changes that read (Matthew L.
Fidler)
* *12-Sep-2012* - Handle errors with the package gracefully. to
include the author name who updated the file. (Matthew L. Fidler)
* *12-Sep-2012* - Handle errors with the package gracefully.
(Matthew L. Fidler)
* *12-Sep-2012* - Bug fix to eliminate duplicate headers in
Readme.org and emacswiki (Matthew L. Fidler)
* *12-Sep-2012* - Bug fix when org todo faces are not set. (Matthew
L. Fidler)
* *12-Sep-2012* - Added bug fix when `org-todo-keyword-faces' is
undefined. (Matthew L. Fidler)
* *22-Aug-2012* - Attempting to upload again (Matthew L. Fidler)
* *22-Aug-2012* - Now will remove variable name and functions from
markdown and outputted texinfo. (Matthew L. Fidler)
* *21-Aug-2012* - Bug fix. When variables/functions are documented
with an initial asterisk, change that asterisk to a bulleted item.
(Matthew L. Fidler)
* *21-Aug-2012* - Another documentation update where I document how
to change the comment and that org-readme may change the minor
revision of the library. (Matthew L. Fidler)
* *21-Aug-2012* - Updated the documentation for org-readme. (Matthew
L. Fidler)
* *20-Aug-2012* - Bug fix for variables that don't really transport
well to the documentation. (Matthew L. Fidler)
* *20-Aug-2012* - Bump minor version for marmalade-repo.org (Matthew
L. Fidler)
* *20-Aug-2012* - Attempt to fix the History list (Matthew L. Fidler)
* *20-Aug-2012* - Added ability to customize which sections are
added to the Readme.org (Matthew L. Fidler)
* *20-Aug-2012* - Bug fix for creating function readme (Matthew L.
Fidler)
* *20-Aug-2012* - Will now remove the Functions and Variables
sections before putting them in the commentary section. (Matthew
L. Fidler)
* *20-Aug-2012* - Attempt to remove Readme.md when not needed.
(Matthew L. Fidler)
* *20-Aug-2012* - Added ability to add function documentation and
variable documentation to the Readme.org file (Matthew L. Fidler)
* *20-Aug-2012* - Added pandoc markdown table support (optional)
(Matthew L. Fidler)
* *13-Aug-2012* - Another attempt to make texinfo documents.
(Matthew L. Fidler)
* *13-Aug-2012* - Added texinfo output. Allows native emacs
documentation. (Matthew L. Fidler)
* *13-Aug-2012* - Tried to post behind firewall. Reattempting.
(Matthew L. Fidler)
* *13-Aug-2012* - Changed the `org-readme-remove-section' to use
`org-cut-subtree'. Hopefully all errors will resolve themselves
now. (Matthew L. Fidler)
* *11-Aug-2012* - Reverted. Still buggy. (Matthew L. Fidler)
* *11-Aug-2012* - Another attempt at bug fix to remove section.
(Matthew L. Fidler)
* *11-Aug-2012* - Another attempt at a remove-section fix. (Matthew
L. Fidler)
* *11-Aug-2012* - Bug fix for org-readme version tagging. (Matthew
L. Fidler)
* *11-Aug-2012* - Test the bug where some of the section text is
deleted (Matthew L. Fidler)
* *11-Aug-2012* - Added more documentation (Matthew L. Fidler)
* *11-Aug-2012* - One last bug fix to the markdown export engine.
(Matthew L. Fidler)
* *11-Aug-2012* - Markdown bug fix (Matthew L. Fidler)
* *11-Aug-2012* - Bug fix for el-get recipe. (Matthew L. Fidler)
* *11-Aug-2012* - Added the ability to create a markdown Readme
(Readme.md) as well as adding a el-get recipe. (Matthew L. Fidler)
* *11-Aug-2012* - Bug fix for emacswiki post and melpa bug fix
(Matthew L. Fidler)
* *11-Aug-2012* - Bug fix for adding melpa recipes. (Matthew L.
Fidler)
* *11-Aug-2012* - Bug fix for creating melpa recipe. (Matthew L.
Fidler)
* *11-Aug-2012* - Added ability to add melpa recipe (Matthew L.
Fidler)
* *11-Aug-2012* - Bug fix for pushing tags to a git repository
(Matthew L. Fidler)
* *11-Aug-2012* - Another fix for git tags. (Matthew L. Fidler)
* *11-Aug-2012* - Found a bug, let see if tagging works now.
(Matthew L. Fidler)
* *11-Aug-2012* - Added Git tagging of new versions. Lets see if it
works. (Matthew L. Fidler)
* *11-Aug-2012* - Git push worked. Bumping minor version. (Matthew
L. Fidler)
* *11-Aug-2012* - Attempted to push repository again. (Matthew L.
Fidler)
* *11-Aug-2012* - Attempt to push with git. Something changed.
(Matthew L. Fidler)
* *11-Aug-2012* - Added better Package-Requires tag. (Matthew L.
Fidler)
* *11-Aug-2012* - Made request for minor revision earlier, and fixed
bug. (Matthew L. Fidler)
* *11-Aug-2012* - Fixed code typo (Matthew L. Fidler)
* *11-Aug-2012* - Bug fix for deleting a section of a Readme.org
file. (Matthew L. Fidler)
* *11-Aug-2012* - Testing bug. (Matthew L. Fidler)
* *11-Aug-2012* - Minor bug fix. (Matthew L. Fidler)
* *11-Aug-2012* - Bug fix for comment sync, now Readme.org `file' is
translated to lisp `file'. Additionally, asks for version bump.
(Matthew L. Fidler)
* *11-Aug-2012* - Bug fix for syncing readme. Now the returns should
not be as prevalent. (Matthew L. Fidler)
* *11-Aug-2012* - Attempting to post to marmlade again... (Matthew
L. Fidler)
* *11-Aug-2012* - Attempting to fix org-readme-marmalade-post.
(Matthew L. Fidler)
* *11-Aug-2012* - Bug fix to upload to emacswiki and upload to
marmalade-repo (Matthew L. Fidler)
* *11-Aug-2012* - Added marmalade-repo support. Now org-readme
should upload to marmalade-repo when the version is different from
the latest version. (Matthew L. Fidler)
* *08-Aug-2012* - Fixed preformatting tags in emacswiki post.
Previously they may have been replaced with <_pre> instead of
<_pre>. This makes the emacswiki page display correctly. (Matthew
L. Fidler)
* *07-Aug-2012* - To use, put (require 'ess-smart-underscore) in
your ~/.emacs file 7-Aug-2012 Matthew L. Fidler Last-Updated: Tue
Aug 7 19:14:34 2012 (-0500) #331 (Matthew L. Fidler) Added a
Comment to EmcsWiki pages that states that the content of the page
will likely be overwitten since it is automatically generated by
`org-readme' 7-Aug-2012 Matthew L. Fidler Last-Updated: Mon Aug 6
23:42:02 2012 (-0500) #328 (Matthew L. Fidler) Added more
documentation. (Matthew L. Fidler)
* *06-Aug-2012* - Added support for uploading Readme.org files to
emacswiki without having to have a single associated lisp file.
(Matthew L. Fidler)
* *06-Aug-2012* - Bug fix for syncing from the single lisp file.
(Matthew L. Fidler)
* *06-Aug-2012* - Added the ability to call `org-readme-sync' from
Readme.org (Matthew L. Fidler)
* *05-Aug-2012* - Added git pushing to org-readme (Matthew L. Fidler)
* *05-Aug-2012* - Added git support as well as a comment mode. The
only thing that should need to be called is `org-readme-sync'
(Matthew L. Fidler)
* *04-Aug-2012* - Added syncing with emacswiki. (Matthew L. Fidler)
* *04-Aug-2012* - Initial Release (Matthew L. Fidler)
Tag Table:
Node: Top242
Node: Org Readme344
Node: Possible Dependencies1262
Node: Using org-readme1418
Node: Why each required library is needed3386
Node: History3902
End Tag Table
Local Variables:
coding: utf-8
End: