Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

No longer deletes ilg files.

  • Loading branch information...
commit a0233269ae11916fa854c2a8a292e2cd7f07da72 1 parent b3546aa
Matthew Fidler authored
9 Readme.org
Source Rendered
@@ -223,6 +223,9 @@ Add a Variables section to Readme.org
223 223 *** org-readme-build-el-get-recipe
224 224 Builds a el-get recipe based on github information
225 225
  226 +*** org-readme-build-info
  227 +Builds library-name.info from Reade.org using texi. Requires =org-readme-build-texi= to be non-nil, pandoc and makeinfo to be found. This will also create the directory entry using install-info, if it is found.
  228 +
226 229 *** org-readme-build-markdown
227 230 Builds Readme.md from Readme.org
228 231
@@ -238,6 +241,9 @@ Default template for blank Readme.org Files. LIB-NAME is replaced with the libra
238 241 *** org-readme-drop-markdown-after-build-texi
239 242 Removes Readme.md after texinfo is generated
240 243
  244 +*** org-readme-drop-texi-after-build-info
  245 +Removes the texi information after building info files.
  246 +
241 247 *** org-readme-marmalade-server
242 248 Marmalade server website. This should start with http: and should notend with a trailing forward slash, just like the default value of http://marmalade-repo.org
243 249
@@ -283,6 +289,9 @@ Value: (keymap
283 289
284 290 * History
285 291
  292 + - 07-Dec-2012 :: No longer deletes ilg files. (Matthew L. Fidler)
  293 + - 07-Dec-2012 :: Bug fix for info generation. (Matthew L. Fidler)
  294 + - 07-Dec-2012 :: Added mecahism to build info files and dir files for elpa package. (Matthew L. Fidler)
286 295 - 07-Dec-2012 :: Get description from info file. (Matthew L. Fidler)
287 296 - 07-Dec-2012 :: The description should now be picked up. (Matthew L. Fidler)
288 297 - 07-Dec-2012 :: Attempting to update description. (Matthew L. Fidler)
19 dir
... ... @@ -0,0 +1,19 @@
  1 +This is the file .../info/dir, which contains the
  2 +topmost node of the Info hierarchy, called (dir)Top.
  3 +The first time you invoke Info you start off looking at this node.
  4 +
  5 +File: dir, Node: Top This is the top of the INFO tree
  6 +
  7 + This (the Directory node) gives a menu of major topics.
  8 + Typing "q" exits, "?" lists all Info commands, "d" returns here,
  9 + "h" gives a primer for first-timers,
  10 + "mEmacs<Return>" visits the Emacs manual, etc.
  11 +
  12 + In Emacs, you can click mouse button 2 on a menu item or cross reference
  13 + to select it.
  14 +
  15 +* Menu:
  16 +
  17 +Emacs lisp libraries
  18 +* org-readme: (org-readme). Integrate Readme.org and Commentary/Change
  19 + Logs.
63 org-readme.el
@@ -79,6 +79,15 @@
79 79 ;;; Change Log:
80 80 ;; 07-Dec-2012 Matthew L. Fidler
81 81 ;; Last-Updated: Wed Aug 22 13:11:26 2012 (-0500) #794 (Matthew L. Fidler)
  82 +;; No longer deletes ilg files.
  83 +;; 07-Dec-2012 Matthew L. Fidler
  84 +;; Last-Updated: Wed Aug 22 13:11:26 2012 (-0500) #794 (Matthew L. Fidler)
  85 +;; Bug fix for info generation.
  86 +;; 07-Dec-2012 Matthew L. Fidler
  87 +;; Last-Updated: Wed Aug 22 13:11:26 2012 (-0500) #794 (Matthew L. Fidler)
  88 +;; Added mecahism to build info files and dir files for elpa package.
  89 +;; 07-Dec-2012 Matthew L. Fidler
  90 +;; Last-Updated: Wed Aug 22 13:11:26 2012 (-0500) #794 (Matthew L. Fidler)
82 91 ;; Get description from info file.
83 92 ;; 07-Dec-2012 Matthew L. Fidler
84 93 ;; Last-Updated: Wed Aug 22 13:11:26 2012 (-0500) #794 (Matthew L. Fidler)
@@ -403,6 +412,16 @@
403 412 :type 'boolean
404 413 :group 'org-readme)
405 414
  415 +(defcustom org-readme-build-info t
  416 + "Builds library-name.info from Reade.org using texi. Requires `org-readme-build-texi' to be non-nil, pandoc and makeinfo to be found. This will also create the directory entry using install-info, if it is found."
  417 + :type 'boolean
  418 + :group 'org-readme)
  419 +
  420 +(defcustom org-readme-drop-texi-after-build-info t
  421 + "Removes the texi information after building info files."
  422 + :type 'boolean
  423 + :group 'org-readme)
  424 +
406 425 (defcustom org-readme-add-functions-to-readme t
407 426 "Add a Functions section to Readme.org"
408 427 :type 'boolean
@@ -1067,12 +1086,37 @@ Returns file name if created."
1067 1086 (delete-file "Readme.md")
1068 1087 (shell-command
1069 1088 (concat "git rm Readme.md")))
1070   - (shell-command
1071   - (concat "git add "
1072   - (concat
1073   - (file-name-sans-extension
1074   - (file-name-nondirectory (buffer-file-name)))
1075   - ".texi"))))
  1089 + (if (and org-readme-drop-texi-after-build-info
  1090 + (file-exists-p (concat
  1091 + (file-name-sans-extension
  1092 + (file-name-nondirectory (buffer-file-name)))
  1093 + ".info")))
  1094 + (progn
  1095 + (delete-file (concat
  1096 + (file-name-sans-extension
  1097 + (file-name-nondirectory (buffer-file-name)))
  1098 + ".texi"))
  1099 + (shell-command
  1100 + (concat "git add "
  1101 + (concat
  1102 + (file-name-sans-extension
  1103 + (file-name-nondirectory (buffer-file-name)))
  1104 + ".info")))
  1105 + (if (file-exists-p (expand-file-name "dir"
  1106 + (file-name-directory (buffer-file-name))))
  1107 + (shell-command
  1108 + (concat "git add dir")))
  1109 + (shell-command
  1110 + (concat "git rm "
  1111 + (file-name-sans-extension
  1112 + (file-name-nondirectory (buffer-file-name)))
  1113 + ".texi")))
  1114 + (shell-command
  1115 + (concat "git add "
  1116 + (concat
  1117 + (file-name-sans-extension
  1118 + (file-name-nondirectory (buffer-file-name)))
  1119 + ".texi")))))
1076 1120
1077 1121 (when (file-exists-p "Readme.md")
1078 1122 (shell-command
@@ -1197,7 +1241,12 @@ When COMMENT-ADDED is non-nil, the comment has been added and the syncing should
1197 1241 (insert base)
1198 1242 (insert "). ")
1199 1243 (insert desc)
1200   - (insert "\n@end direntry\n")))))))
  1244 + (insert "\n@end direntry\n")))
  1245 + (when (and org-readme-build-info
  1246 + (executable-find "makeinfo"))
  1247 + (shell-command (concat "makeinfo " base ".texi"))
  1248 + (when (executable-find "install-info")
  1249 + (shell-command (concat "install-info --dir-file=dir " base ".info"))))))))
1201 1250
1202 1251 (when (and (featurep 'http-post-simple)
1203 1252 org-readme-sync-marmalade)
388 org-readme.info
... ... @@ -0,0 +1,388 @@
  1 +This is org-readme.info, produced by makeinfo version 4.13 from
  2 +org-readme.texi.
  3 +
  4 +INFO-DIR-SECTION Emacs lisp libraries
  5 +START-INFO-DIR-ENTRY
  6 +* org-readme: (org-readme). Integrate Readme.org and Commentary/Change Logs.
  7 +END-INFO-DIR-ENTRY
  8 +
  9 +
  10 +File: org-readme.info, Node: Top, Next: Org Readme, Up: (dir)
  11 +
  12 +Top
  13 +***
  14 +
  15 +* Menu:
  16 +
  17 +* Org Readme::
  18 +
  19 +
  20 +File: org-readme.info, Node: Org Readme, Prev: Top, Up: Top
  21 +
  22 +1 Org Readme
  23 +************
  24 +
  25 +Matthew L. Fidler ## Library Information _org-readme.el_ -- Integrates
  26 +Readme.org and Commentary/Change-logs.
  27 +
  28 + * *Filename* - org-readme.el
  29 +
  30 + * *Description* - Integrate Readme.org and Commentary/Change Logs.
  31 +
  32 + * *Author* - Matthew L. Fidler
  33 +
  34 + * *Maintainer* - Matthew L. Fidler
  35 +
  36 + * *Created* - Fri Aug 3 22:33:41 2012 (-0500)
  37 +
  38 + * *Version* - 0.34
  39 +
  40 + * *Package-Requires* - ((http-post-simple "1.0") (yaoddmuse
  41 + "0.1.1")(header2 "21.0") (lib-requires "21.0"))
  42 +
  43 + * *Last-Updated* - Wed Aug 22 13:11:26 2012 (-0500)
  44 +
  45 + * *By* - Matthew L. Fidler
  46 +
  47 + * *Update #* - 794
  48 +
  49 + * *URL* - https:__github.com_mlf176f2_org-readme
  50 +
  51 + * *Keywords* - Header2, Readme.org, Emacswiki, Git
  52 +
  53 + * *Compatibility* - Tested with Emacs 24.1 on Windows.
  54 +
  55 +* Menu:
  56 +
  57 +* Possible Dependencies::
  58 +* Using org-readme::
  59 +* History::
  60 +
  61 +
  62 +File: org-readme.info, Node: Possible Dependencies, Next: Using org-readme, Up: Org Readme
  63 +
  64 +1.1 Possible Dependencies
  65 +=========================
  66 +
  67 +None
  68 +
  69 +
  70 +File: org-readme.info, Node: Using org-readme, Next: History, Prev: Possible Dependencies, Up: Org Readme
  71 +
  72 +1.2 Using org-readme
  73 +====================
  74 +
  75 +Org readme is used to:
  76 +
  77 + * Create/Update a "History" section in the Readme.org based on the
  78 + changelog section of the Emacs Log.
  79 +
  80 + * Create/Update a "Library Information" Section Based on the Emacs
  81 + lisp header.
  82 +
  83 + * Create/Update a "Possible Dependencies" Section Based on the Emacs
  84 + lisp header.
  85 +
  86 + * Create/Update a "Functions" Section based on the functions defined
  87 + in the single lisp library.
  88 +
  89 + * Create/Update a "Variables" Section based on the variables defined
  90 + in the single lisp library.
  91 +
  92 +All other sections of the Readme.org are then put into the "Commentary"
  93 +section of the readme.org.
  94 +
  95 +In addition this library defines `org-readme-sync', a convenience
  96 +function that:
  97 +
  98 + * Asks for a commentary about the library change.
  99 +
  100 + * To exit/save press `C-c C-c'
  101 +
  102 + * Asks if this is a minor revision
  103 +
  104 + * If it is a minor revision, bumps the revision up so the new
  105 + library will be posted to marmalade-repo.org
  106 +
  107 + * Syncs the Readme.org with the lisp file as described above.
  108 +
  109 + * Updates emacswiki with the library description and the library
  110 + itself (requires yaoddmuse).
  111 +
  112 + * Updates Marmalade-repo if the library version is different than
  113 + the version in the server (requires http-post-simple).
  114 +
  115 + * Updates the git repository with the differences that you posted.
  116 +
  117 + * If you are using github, this library creates a melpa recipie.
  118 +
  119 + * If you are using github, this library creates a el-get recipie.
  120 +
  121 +When `org-readme-sync' is called in a `Readme.org' file that is not a
  122 +single lisp file, the function exports the readme in EmacsWiki format
  123 +and posts it to the EmacsWiki. ### EmacsWiki Page Names EmacsWiki Page
  124 +names are generated from the file. `org-readme.el' would generate a
  125 +page of OrgReadme.
  126 +
  127 +* Menu:
  128 +
  129 +* Why each required library is needed::
  130 +
  131 +
  132 +File: org-readme.info, Node: Why each required library is needed, Up: Using org-readme
  133 +
  134 +1.2.1 Why each required library is needed
  135 +-----------------------------------------
  136 +
  137 +There are a few required libraries. This is a list of the require
  138 +libraries and why they are needed.
  139 +
  140 +Library Why it is needed
  141 +yaoddmuse Publish to emacswiki Publish to
  142 +http-post-simple marmalade-repo.org To create header
  143 +header2 and changelog To generate the library
  144 +lib-requires dependencies
  145 +
  146 +
  147 +File: org-readme.info, Node: History, Prev: Using org-readme, Up: Org Readme
  148 +
  149 +1.3 History
  150 +===========
  151 +
  152 + * *07-Dec-2012* - No longer deletes ilg files. (Matthew L. Fidler)
  153 +
  154 + * *07-Dec-2012* - Bug fix for info generation. (Matthew L. Fidler)
  155 +
  156 + * *07-Dec-2012* - Added mecahism to build info files and dir files
  157 + for elpa package. (Matthew L. Fidler)
  158 +
  159 + * *07-Dec-2012* - Get description from info file. (Matthew L. Fidler)
  160 +
  161 + * *07-Dec-2012* - The description should now be picked up. (Matthew
  162 + L. Fidler)
  163 +
  164 + * *07-Dec-2012* - Attempting to update description. (Matthew L.
  165 + Fidler)
  166 +
  167 + * *07-Dec-2012* - Test directory entry (Matthew L. Fidler)
  168 +
  169 + * *07-Dec-2012* - Added directory entry to texinfo file. (Matthew L.
  170 + Fidler)
  171 +
  172 + * *18-Sep-2012* - Bug fix to allow changes that read (Matthew L.
  173 + Fidler)
  174 +
  175 + * *12-Sep-2012* - Handle errors with the package gracefully. to
  176 + include the author name who updated the file. (Matthew L. Fidler)
  177 +
  178 + * *12-Sep-2012* - Handle errors with the package gracefully.
  179 + (Matthew L. Fidler)
  180 +
  181 + * *12-Sep-2012* - Bug fix to eliminate duplicate headers in
  182 + Readme.org and emacswiki (Matthew L. Fidler)
  183 +
  184 + * *12-Sep-2012* - Bug fix when org todo faces are not set. (Matthew
  185 + L. Fidler)
  186 +
  187 + * *12-Sep-2012* - Added bug fix when `org-todo-keyword-faces' is
  188 + undefined. (Matthew L. Fidler)
  189 +
  190 + * *22-Aug-2012* - Attempting to upload again (Matthew L. Fidler)
  191 +
  192 + * *22-Aug-2012* - Now will remove variable name and functions from
  193 + markdown and outputted texinfo. (Matthew L. Fidler)
  194 +
  195 + * *21-Aug-2012* - Bug fix. When variables/functions are documented
  196 + with an initial asterisk, change that asterisk to a bulleted item.
  197 + (Matthew L. Fidler)
  198 +
  199 + * *21-Aug-2012* - Another documentation update where I document how
  200 + to change the comment and that org-readme may change the minor
  201 + revision of the library. (Matthew L. Fidler)
  202 +
  203 + * *21-Aug-2012* - Updated the documentation for org-readme. (Matthew
  204 + L. Fidler)
  205 +
  206 + * *20-Aug-2012* - Bug fix for variables that don't really transport
  207 + well to the documentation. (Matthew L. Fidler)
  208 +
  209 + * *20-Aug-2012* - Bump minor version for marmalade-repo.org (Matthew
  210 + L. Fidler)
  211 +
  212 + * *20-Aug-2012* - Attempt to fix the History list (Matthew L. Fidler)
  213 +
  214 + * *20-Aug-2012* - Added ability to customize which sections are
  215 + added to the Readme.org (Matthew L. Fidler)
  216 +
  217 + * *20-Aug-2012* - Bug fix for creating function readme (Matthew L.
  218 + Fidler)
  219 +
  220 + * *20-Aug-2012* - Will now remove the Functions and Variables
  221 + sections before putting them in the commentary section. (Matthew
  222 + L. Fidler)
  223 +
  224 + * *20-Aug-2012* - Attempt to remove Readme.md when not needed.
  225 + (Matthew L. Fidler)
  226 +
  227 + * *20-Aug-2012* - Added ability to add function documentation and
  228 + variable documentation to the Readme.org file (Matthew L. Fidler)
  229 +
  230 + * *20-Aug-2012* - Added pandoc markdown table support (optional)
  231 + (Matthew L. Fidler)
  232 +
  233 + * *13-Aug-2012* - Another attempt to make texinfo documents.
  234 + (Matthew L. Fidler)
  235 +
  236 + * *13-Aug-2012* - Added texinfo output. Allows native emacs
  237 + documentation. (Matthew L. Fidler)
  238 +
  239 + * *13-Aug-2012* - Tried to post behind firewall. Reattempting.
  240 + (Matthew L. Fidler)
  241 +
  242 + * *13-Aug-2012* - Changed the `org-readme-remove-section' to use
  243 + `org-cut-subtree'. Hopefully all errors will resolve themselves
  244 + now. (Matthew L. Fidler)
  245 +
  246 + * *11-Aug-2012* - Reverted. Still buggy. (Matthew L. Fidler)
  247 +
  248 + * *11-Aug-2012* - Another attempt at bug fix to remove section.
  249 + (Matthew L. Fidler)
  250 +
  251 + * *11-Aug-2012* - Another attempt at a remove-section fix. (Matthew
  252 + L. Fidler)
  253 +
  254 + * *11-Aug-2012* - Bug fix for org-readme version tagging. (Matthew
  255 + L. Fidler)
  256 +
  257 + * *11-Aug-2012* - Test the bug where some of the section text is
  258 + deleted (Matthew L. Fidler)
  259 +
  260 + * *11-Aug-2012* - Added more documentation (Matthew L. Fidler)
  261 +
  262 + * *11-Aug-2012* - One last bug fix to the markdown export engine.
  263 + (Matthew L. Fidler)
  264 +
  265 + * *11-Aug-2012* - Markdown bug fix (Matthew L. Fidler)
  266 +
  267 + * *11-Aug-2012* - Bug fix for el-get recipe. (Matthew L. Fidler)
  268 +
  269 + * *11-Aug-2012* - Added the ability to create a markdown Readme
  270 + (Readme.md) as well as adding a el-get recipe. (Matthew L. Fidler)
  271 +
  272 + * *11-Aug-2012* - Bug fix for emacswiki post and melpa bug fix
  273 + (Matthew L. Fidler)
  274 +
  275 + * *11-Aug-2012* - Bug fix for adding melpa recipes. (Matthew L.
  276 + Fidler)
  277 +
  278 + * *11-Aug-2012* - Bug fix for creating melpa recipe. (Matthew L.
  279 + Fidler)
  280 +
  281 + * *11-Aug-2012* - Added ability to add melpa recipe (Matthew L.
  282 + Fidler)
  283 +
  284 + * *11-Aug-2012* - Bug fix for pushing tags to a git repository
  285 + (Matthew L. Fidler)
  286 +
  287 + * *11-Aug-2012* - Another fix for git tags. (Matthew L. Fidler)
  288 +
  289 + * *11-Aug-2012* - Found a bug, let see if tagging works now.
  290 + (Matthew L. Fidler)
  291 +
  292 + * *11-Aug-2012* - Added Git tagging of new versions. Lets see if it
  293 + works. (Matthew L. Fidler)
  294 +
  295 + * *11-Aug-2012* - Git push worked. Bumping minor version. (Matthew
  296 + L. Fidler)
  297 +
  298 + * *11-Aug-2012* - Attempted to push repository again. (Matthew L.
  299 + Fidler)
  300 +
  301 + * *11-Aug-2012* - Attempt to push with git. Something changed.
  302 + (Matthew L. Fidler)
  303 +
  304 + * *11-Aug-2012* - Added better Package-Requires tag. (Matthew L.
  305 + Fidler)
  306 +
  307 + * *11-Aug-2012* - Made request for minor revision earlier, and fixed
  308 + bug. (Matthew L. Fidler)
  309 +
  310 + * *11-Aug-2012* - Fixed code typo (Matthew L. Fidler)
  311 +
  312 + * *11-Aug-2012* - Bug fix for deleting a section of a Readme.org
  313 + file. (Matthew L. Fidler)
  314 +
  315 + * *11-Aug-2012* - Testing bug. (Matthew L. Fidler)
  316 +
  317 + * *11-Aug-2012* - Minor bug fix. (Matthew L. Fidler)
  318 +
  319 + * *11-Aug-2012* - Bug fix for comment sync, now Readme.org `file' is
  320 + translated to lisp `file'. Additionally, asks for version bump.
  321 + (Matthew L. Fidler)
  322 +
  323 + * *11-Aug-2012* - Bug fix for syncing readme. Now the returns should
  324 + not be as prevalent. (Matthew L. Fidler)
  325 +
  326 + * *11-Aug-2012* - Attempting to post to marmlade again... (Matthew
  327 + L. Fidler)
  328 +
  329 + * *11-Aug-2012* - Attempting to fix org-readme-marmalade-post.
  330 + (Matthew L. Fidler)
  331 +
  332 + * *11-Aug-2012* - Bug fix to upload to emacswiki and upload to
  333 + marmalade-repo (Matthew L. Fidler)
  334 +
  335 + * *11-Aug-2012* - Added marmalade-repo support. Now org-readme
  336 + should upload to marmalade-repo when the version is different from
  337 + the latest version. (Matthew L. Fidler)
  338 +
  339 + * *08-Aug-2012* - Fixed preformatting tags in emacswiki post.
  340 + Previously they may have been replaced with <_pre> instead of
  341 + <_pre>. This makes the emacswiki page display correctly. (Matthew
  342 + L. Fidler)
  343 +
  344 + * *07-Aug-2012* - To use, put (require 'ess-smart-underscore) in
  345 + your ~/.emacs file 7-Aug-2012 Matthew L. Fidler Last-Updated: Tue
  346 + Aug 7 19:14:34 2012 (-0500) #331 (Matthew L. Fidler) Added a
  347 + Comment to EmcsWiki pages that states that the content of the page
  348 + will likely be overwitten since it is automatically generated by
  349 + `org-readme' 7-Aug-2012 Matthew L. Fidler Last-Updated: Mon Aug 6
  350 + 23:42:02 2012 (-0500) #328 (Matthew L. Fidler) Added more
  351 + documentation. (Matthew L. Fidler)
  352 +
  353 + * *06-Aug-2012* - Added support for uploading Readme.org files to
  354 + emacswiki without having to have a single associated lisp file.
  355 + (Matthew L. Fidler)
  356 +
  357 + * *06-Aug-2012* - Bug fix for syncing from the single lisp file.
  358 + (Matthew L. Fidler)
  359 +
  360 + * *06-Aug-2012* - Added the ability to call `org-readme-sync' from
  361 + Readme.org (Matthew L. Fidler)
  362 +
  363 + * *05-Aug-2012* - Added git pushing to org-readme (Matthew L. Fidler)
  364 +
  365 + * *05-Aug-2012* - Added git support as well as a comment mode. The
  366 + only thing that should need to be called is `org-readme-sync'
  367 + (Matthew L. Fidler)
  368 +
  369 + * *04-Aug-2012* - Added syncing with emacswiki. (Matthew L. Fidler)
  370 +
  371 + * *04-Aug-2012* - Initial Release (Matthew L. Fidler)
  372 +
  373 +
  374 +
  375 +Tag Table:
  376 +Node: Top242
  377 +Node: Org Readme344
  378 +Node: Possible Dependencies1262
  379 +Node: Using org-readme1418
  380 +Node: Why each required library is needed3386
  381 +Node: History3902
  382 +
  383 +End Tag Table
  384 +
  385 +
  386 +Local Variables:
  387 +coding: utf-8
  388 +End:
273 org-readme.texi
... ... @@ -1,273 +0,0 @@
1   -\input texinfo
2   -@documentencoding UTF-8
3   -@dircategory Emacs lisp libraries
4   -@direntry
5   -* org-readme: (org-readme). Integrate Readme.org and Commentary/Change Logs.
6   -@end direntry
7   -
8   -
9   -@ifnottex
10   -@paragraphindent 0
11   -@end ifnottex
12   -@node Top
13   -@top Top
14   -
15   -@menu
16   -* Org Readme::
17   -@end menu
18   -
19   -@node Org Readme
20   -@chapter Org Readme
21   -Matthew L. Fidler ## Library Information @emph{org-readme.el} --- Integrates Readme.org and Commentary/Change-logs.
22   -
23   -@itemize
24   -@item
25   -@strong{Filename} -- org-readme.el
26   -@item
27   -@strong{Description} -- Integrate Readme.org and Commentary/Change Logs.
28   -@item
29   -@strong{Author} -- Matthew L. Fidler
30   -@item
31   -@strong{Maintainer} -- Matthew L. Fidler
32   -@item
33   -@strong{Created} -- Fri Aug 3 22:33:41 2012 (-0500)
34   -@item
35   -@strong{Version} -- 0.34
36   -@item
37   -@strong{Package-Requires} -- ((http-post-simple "1.0") (yaoddmuse "0.1.1")(header2 "21.0") (lib-requires "21.0"))
38   -@item
39   -@strong{Last-Updated} -- Wed Aug 22 13:11:26 2012 (-0500)
40   -@item
41   -@strong{By} -- Matthew L. Fidler
42   -@item
43   -@strong{Update #} -- 794
44   -@item
45   -@strong{URL} -- https:__github.com_mlf176f2_org-readme
46   -@item
47   -@strong{Keywords} -- Header2@comma{} Readme.org@comma{} Emacswiki@comma{} Git
48   -@item
49   -@strong{Compatibility} -- Tested with Emacs 24.1 on Windows.
50   -@end itemize
51   -
52   -@menu
53   -* Possible Dependencies::
54   -* Using org-readme::
55   -* History::
56   -@end menu
57   -
58   -@node Possible Dependencies
59   -@section Possible Dependencies
60   -None
61   -
62   -@node Using org-readme
63   -@section Using org-readme
64   -Org readme is used to:
65   -
66   -@itemize
67   -@item
68   -Create/Update a "History" section in the Readme.org based on the changelog section of the Emacs Log.
69   -@item
70   -Create/Update a "Library Information" Section Based on the Emacs lisp header.
71   -@item
72   -Create/Update a "Possible Dependencies" Section Based on the Emacs lisp header.
73   -@item
74   -Create/Update a "Functions" Section based on the functions defined in the single lisp library.
75   -@item
76   -Create/Update a "Variables" Section based on the variables defined in the single lisp library.
77   -@end itemize
78   -
79   -All other sections of the Readme.org are then put into the "Commentary" section of the readme.org.
80   -
81   -In addition this library defines @code{org-readme-sync}@comma{} a convenience function that:
82   -
83   -@itemize
84   -@item
85   -Asks for a commentary about the library change.
86   -@item
87   -To exit/save press @code{C-c C-c}
88   -@item
89   -Asks if this is a minor revision
90   -@item
91   -If it is a minor revision@comma{} bumps the revision up so the new library will be posted to marmalade-repo.org
92   -@item
93   -Syncs the Readme.org with the lisp file as described above.
94   -@item
95   -Updates emacswiki with the library description and the library itself (requires yaoddmuse).
96   -@item
97   -Updates Marmalade-repo if the library version is different than the version in the server (requires http-post-simple).
98   -@item
99   -Updates the git repository with the differences that you posted.
100   -@item
101   -If you are using github@comma{} this library creates a melpa recipie.
102   -@item
103   -If you are using github@comma{} this library creates a el-get recipie.
104   -@end itemize
105   -
106   -When @code{org-readme-sync} is called in a @code{Readme.org} file that is not a single lisp file@comma{} 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. @code{org-readme.el} would generate a page of OrgReadme.
107   -@menu
108   -* Why each required library is needed::
109   -@end menu
110   -
111   -@node Why each required library is needed
112   -@subsection Why each required library is needed
113   -There are a few required libraries. This is a list of the require libraries and why they are needed.
114   -
115   -@multitable @columnfractions 0.26 0.54
116   -@item
117   -Library
118   - @tab Why it is needed
119   -@item
120   -yaoddmuse http-post-simple header2 lib-requires
121   - @tab Publish to emacswiki Publish to marmalade-repo.org To create header and changelog To generate the library dependencies
122   -@end multitable
123   -
124   -@node History
125   -@section History
126   -@itemize
127   -@item
128   -@strong{07-Dec-2012} -- Get description from info file. (Matthew L. Fidler)
129   -@item
130   -@strong{07-Dec-2012} -- The description should now be picked up. (Matthew L. Fidler)
131   -@item
132   -@strong{07-Dec-2012} -- Attempting to update description. (Matthew L. Fidler)
133   -@item
134   -@strong{07-Dec-2012} -- Test directory entry (Matthew L. Fidler)
135   -@item
136   -@strong{07-Dec-2012} -- Added directory entry to texinfo file. (Matthew L. Fidler)
137   -@item
138   -@strong{18-Sep-2012} -- Bug fix to allow changes that read (Matthew L. Fidler)
139   -@item
140   -@strong{12-Sep-2012} -- Handle errors with the package gracefully. to include the author name who updated the file. (Matthew L. Fidler)
141   -@item
142   -@strong{12-Sep-2012} -- Handle errors with the package gracefully. (Matthew L. Fidler)
143   -@item
144   -@strong{12-Sep-2012} -- Bug fix to eliminate duplicate headers in Readme.org and emacswiki (Matthew L. Fidler)
145   -@item
146   -@strong{12-Sep-2012} -- Bug fix when org todo faces are not set. (Matthew L. Fidler)
147   -@item
148   -@strong{12-Sep-2012} -- Added bug fix when @code{org-todo-keyword-faces} is undefined. (Matthew L. Fidler)
149   -@item
150   -@strong{22-Aug-2012} -- Attempting to upload again (Matthew L. Fidler)
151   -@item
152   -@strong{22-Aug-2012} -- Now will remove variable name and functions from markdown and outputted texinfo. (Matthew L. Fidler)
153   -@item
154   -@strong{21-Aug-2012} -- Bug fix. When variables/functions are documented with an initial asterisk@comma{} change that asterisk to a bulleted item. (Matthew L. Fidler)
155   -@item
156   -@strong{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)
157   -@item
158   -@strong{21-Aug-2012} -- Updated the documentation for org-readme. (Matthew L. Fidler)
159   -@item
160   -@strong{20-Aug-2012} -- Bug fix for variables that don't really transport well to the documentation. (Matthew L. Fidler)
161   -@item
162   -@strong{20-Aug-2012} -- Bump minor version for marmalade-repo.org (Matthew L. Fidler)
163   -@item
164   -@strong{20-Aug-2012} -- Attempt to fix the History list (Matthew L. Fidler)
165   -@item
166   -@strong{20-Aug-2012} -- Added ability to customize which sections are added to the Readme.org (Matthew L. Fidler)
167   -@item
168   -@strong{20-Aug-2012} -- Bug fix for creating function readme (Matthew L. Fidler)
169   -@item
170   -@strong{20-Aug-2012} -- Will now remove the Functions and Variables sections before putting them in the commentary section. (Matthew L. Fidler)
171   -@item
172   -@strong{20-Aug-2012} -- Attempt to remove Readme.md when not needed. (Matthew L. Fidler)
173   -@item
174   -@strong{20-Aug-2012} -- Added ability to add function documentation and variable documentation to the Readme.org file (Matthew L. Fidler)
175   -@item
176   -@strong{20-Aug-2012} -- Added pandoc markdown table support (optional) (Matthew L. Fidler)
177   -@item
178   -@strong{13-Aug-2012} -- Another attempt to make texinfo documents. (Matthew L. Fidler)
179   -@item
180   -@strong{13-Aug-2012} -- Added texinfo output. Allows native emacs documentation. (Matthew L. Fidler)
181   -@item
182   -@strong{13-Aug-2012} -- Tried to post behind firewall. Reattempting. (Matthew L. Fidler)
183   -@item
184   -@strong{13-Aug-2012} -- Changed the @code{org-readme-remove-section} to use @code{org-cut-subtree}. Hopefully all errors will resolve themselves now. (Matthew L. Fidler)
185   -@item
186   -@strong{11-Aug-2012} -- Reverted. Still buggy. (Matthew L. Fidler)
187   -@item
188   -@strong{11-Aug-2012} -- Another attempt at bug fix to remove section. (Matthew L. Fidler)
189   -@item
190   -@strong{11-Aug-2012} -- Another attempt at a remove-section fix. (Matthew L. Fidler)
191   -@item
192   -@strong{11-Aug-2012} -- Bug fix for org-readme version tagging. (Matthew L. Fidler)
193   -@item
194   -@strong{11-Aug-2012} -- Test the bug where some of the section text is deleted (Matthew L. Fidler)
195   -@item
196   -@strong{11-Aug-2012} -- Added more documentation (Matthew L. Fidler)
197   -@item
198   -@strong{11-Aug-2012} -- One last bug fix to the markdown export engine. (Matthew L. Fidler)
199   -@item
200   -@strong{11-Aug-2012} -- Markdown bug fix (Matthew L. Fidler)
201   -@item
202   -@strong{11-Aug-2012} -- Bug fix for el-get recipe. (Matthew L. Fidler)
203   -@item
204   -@strong{11-Aug-2012} -- Added the ability to create a markdown Readme (Readme.md) as well as adding a el-get recipe. (Matthew L. Fidler)
205   -@item
206   -@strong{11-Aug-2012} -- Bug fix for emacswiki post and melpa bug fix (Matthew L. Fidler)
207   -@item
208   -@strong{11-Aug-2012} -- Bug fix for adding melpa recipes. (Matthew L. Fidler)
209   -@item
210   -@strong{11-Aug-2012} -- Bug fix for creating melpa recipe. (Matthew L. Fidler)
211   -@item
212   -@strong{11-Aug-2012} -- Added ability to add melpa recipe (Matthew L. Fidler)
213   -@item
214   -@strong{11-Aug-2012} -- Bug fix for pushing tags to a git repository (Matthew L. Fidler)
215   -@item
216   -@strong{11-Aug-2012} -- Another fix for git tags. (Matthew L. Fidler)
217   -@item
218   -@strong{11-Aug-2012} -- Found a bug@comma{} let see if tagging works now. (Matthew L. Fidler)
219   -@item
220   -@strong{11-Aug-2012} -- Added Git tagging of new versions. Lets see if it works. (Matthew L. Fidler)
221   -@item
222   -@strong{11-Aug-2012} -- Git push worked. Bumping minor version. (Matthew L. Fidler)
223   -@item
224   -@strong{11-Aug-2012} -- Attempted to push repository again. (Matthew L. Fidler)
225   -@item
226   -@strong{11-Aug-2012} -- Attempt to push with git. Something changed. (Matthew L. Fidler)
227   -@item
228   -@strong{11-Aug-2012} -- Added better Package-Requires tag. (Matthew L. Fidler)
229   -@item
230   -@strong{11-Aug-2012} -- Made request for minor revision earlier@comma{} and fixed bug. (Matthew L. Fidler)
231   -@item
232   -@strong{11-Aug-2012} -- Fixed code typo (Matthew L. Fidler)
233   -@item
234   -@strong{11-Aug-2012} -- Bug fix for deleting a section of a Readme.org file. (Matthew L. Fidler)
235   -@item
236   -@strong{11-Aug-2012} -- Testing bug. (Matthew L. Fidler)
237   -@item
238   -@strong{11-Aug-2012} -- Minor bug fix. (Matthew L. Fidler)
239   -@item
240   -@strong{11-Aug-2012} -- Bug fix for comment sync@comma{} now Readme.org @code{file} is translated to lisp @code{file}. Additionally@comma{} asks for version bump. (Matthew L. Fidler)
241   -@item
242   -@strong{11-Aug-2012} -- Bug fix for syncing readme. Now the returns should not be as prevalent. (Matthew L. Fidler)
243   -@item
244   -@strong{11-Aug-2012} -- Attempting to post to marmlade again... (Matthew L. Fidler)
245   -@item
246   -@strong{11-Aug-2012} -- Attempting to fix org-readme-marmalade-post. (Matthew L. Fidler)
247   -@item
248   -@strong{11-Aug-2012} -- Bug fix to upload to emacswiki and upload to marmalade-repo (Matthew L. Fidler)
249   -@item
250   -@strong{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)
251   -@item
252   -@strong{08-Aug-2012} -- Fixed preformatting tags in emacswiki post. Previously they may have been replaced with
253   -<_pre> instead of
254   -<_pre>. This makes the emacswiki page display correctly. (Matthew L. Fidler)
255   -@item
256   -@strong{07-Aug-2012} -- To use@comma{} 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 @code{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)
257   -@item
258   -@strong{06-Aug-2012} -- Added support for uploading Readme.org files to emacswiki without having to have a single associated lisp file. (Matthew L. Fidler)
259   -@item
260   -@strong{06-Aug-2012} -- Bug fix for syncing from the single lisp file. (Matthew L. Fidler)
261   -@item
262   -@strong{06-Aug-2012} -- Added the ability to call @code{org-readme-sync} from Readme.org (Matthew L. Fidler)
263   -@item
264   -@strong{05-Aug-2012} -- Added git pushing to org-readme (Matthew L. Fidler)
265   -@item
266   -@strong{05-Aug-2012} -- Added git support as well as a comment mode. The only thing that should need to be called is @code{org-readme-sync} (Matthew L. Fidler)
267   -@item
268   -@strong{04-Aug-2012} -- Added syncing with emacswiki. (Matthew L. Fidler)
269   -@item
270   -@strong{04-Aug-2012} -- Initial Release (Matthew L. Fidler)
271   -@end itemize
272   -
273   -@bye

0 comments on commit a023326

Please sign in to comment.
Something went wrong with that request. Please try again.