Permalink
Browse files

Another attempt to make texinfo documents.

  • Loading branch information...
mattfidler committed Aug 14, 2012
1 parent 5bad5d5 commit 0b1170110007ddb125b58380b002ee8df54aa33c
Showing with 229 additions and 8 deletions.
  1. +4 −3 Readme.md
  2. +4 −3 Readme.org
  3. +10 −2 org-readme.el
  4. +211 −0 org-readme.texi
View
@@ -10,9 +10,9 @@
- __Created__ -- Fri Aug 3 22:33:41 2012 (-0500)
- __Version__ -- 0.22
- __Package-Requires__ -- ((http-post-simple "1.0") (yaoddmuse "0.1.1")(header2 "21.0") (lib-requires "21.0"))
-- __Last-Updated__ -- Mon Aug 13 17:24:07 2012 (-0500)
+- __Last-Updated__ -- Mon Aug 13 21:53:01 2012 (-0500)
- __By__ -- Matthew L. Fidler
-- __Update #__ -- 677
+- __Update #__ -- 680
- __URL__ -- https:__github.com_mlf176f2_org-readme
- __Keywords__ -- Header2, Readme.org, Emacswiki, Git
- __Compatibility__ -- Tested with Emacs 24.1 on Windows.
@@ -76,6 +76,7 @@ libraries and why they are needed.
## History
+- __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)
@@ -113,7 +114,7 @@ libraries and why they are needed.
- __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><_pre> instead of <pre><_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: Mon Aug 13 17:24:57 2012 (-0500)
+- __07-Aug-2012__ -- To use, put (require 'ess-smart-underscore) in your ~/.emacs file 7-Aug-2012 Matthew L. Fidler Last-Updated: Mon Aug 13 21:53:20 2012 (-0500)
- __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)
View
@@ -10,9 +10,9 @@
- Created :: Fri Aug 3 22:33:41 2012 (-0500)
- Version :: 0.22
- Package-Requires :: ((http-post-simple "1.0") (yaoddmuse "0.1.1")(header2 "21.0") (lib-requires "21.0"))
- - Last-Updated :: Mon Aug 13 17:24:07 2012 (-0500)
+ - Last-Updated :: Mon Aug 13 21:53:01 2012 (-0500)
- By :: Matthew L. Fidler
- - Update # :: 677
+ - Update # :: 680
- URL :: https://github.com/mlf176f2/org-readme
- Keywords :: Header2, Readme.org, Emacswiki, Git
- Compatibility :: Tested with Emacs 24.1 on Windows.
@@ -67,6 +67,7 @@ libraries and why they are needed.
* History
+ - 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)
@@ -104,7 +105,7 @@ libraries and why they are needed.
- 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></pre> instead of <pre></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: Mon Aug 13 17:24:57 2012 (-0500)
+ - 07-Aug-2012 :: To use, put (require 'ess-smart-underscore) in your ~/.emacs file 7-Aug-2012 Matthew L. Fidler Last-Updated: Mon Aug 13 21:53:20 2012 (-0500)
- 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)
View
@@ -7,9 +7,9 @@
;; Created: Fri Aug 3 22:33:41 2012 (-0500)
;; Version: 0.22
;; Package-Requires: ((http-post-simple "1.0") (yaoddmuse "0.1.1")(header2 "21.0") (lib-requires "21.0"))
-;; Last-Updated: Mon Aug 13 17:25:06 2012 (-0500)
+;; Last-Updated: Mon Aug 13 21:53:26 2012 (-0500)
;; By: Matthew L. Fidler
-;; Update #: 678
+;; Update #: 681
;; URL: https://github.com/mlf176f2/org-readme
;; Keywords: Header2, Readme.org, Emacswiki, Git
;; Compatibility: Tested with Emacs 24.1 on Windows.
@@ -70,6 +70,9 @@
;;
;;; Change Log:
;; 13-Aug-2012 Matthew L. Fidler
+;; Last-Updated: Mon Aug 13 21:52:37 2012 (-0500) #679 (Matthew L. Fidler)
+;; Another attempt to make texinfo documents.
+;; 13-Aug-2012 Matthew L. Fidler
;; Last-Updated: Mon Aug 13 17:23:40 2012 (-0500) #676 (Matthew L. Fidler)
;; Added texinfo output. Allows native emacs documentation.
;; 13-Aug-2012 Matthew L. Fidler
@@ -907,6 +910,11 @@ When COMMENT-ADDED is non-nil, the comment has been added and the syncing should
(when org-readme-build-texi
(when (executable-find "pandoc")
(let ((default-directory (file-name-directory (buffer-file-name))))
+ (message "%s\n%s" default-directory
+ (concat "pandoc Readme.md -s -o "
+ (file-name-sans-extension
+ (file-name-nondirectory (buffer-file-name)))
+ ".texi"))
(shell-command (concat "pandoc Readme.md -s -o "
(file-name-sans-extension
(file-name-nondirectory (buffer-file-name)))
View
@@ -0,0 +1,211 @@
+\input texinfo
+@documentencoding UTF-8
+
+@ifnottex
+@paragraphindent 0
+@end ifnottex
+@node Top
+@top Top
+
+@menu
+* Org Readme::
+@end menu
+
+@node Org Readme
+@chapter Org Readme
+Matthew L. Fidler ## Library Information @strong{org-readme.el} --- Integrates Readme.org and Commentary/Change-logs.
+
+@itemize
+@item
+@strong{Filename} -- org-readme.el
+@item
+@strong{Description} -- Integrate Readme.org and Commentary/Change Logs.
+@item
+@strong{Author} -- Matthew L. Fidler
+@item
+@strong{Maintainer} -- Matthew L. Fidler
+@item
+@strong{Created} -- Fri Aug 3 22:33:41 2012 (-0500)
+@item
+@strong{Version} -- 0.22
+@item
+@strong{Package-Requires} -- ((http-post-simple "1.0") (yaoddmuse "0.1.1")(header2 "21.0") (lib-requires "21.0"))
+@item
+@strong{Last-Updated} -- Mon Aug 13 21:53:01 2012 (-0500)
+@item
+@strong{By} -- Matthew L. Fidler
+@item
+@strong{Update #} -- 680
+@item
+@strong{URL} -- https:__github.com_mlf176f2_org-readme
+@item
+@strong{Keywords} -- Header2@comma{} Readme.org@comma{} Emacswiki@comma{} Git
+@item
+@strong{Compatibility} -- Tested with Emacs 24.1 on Windows.
+@end itemize
+
+@menu
+* Possible Dependencies::
+* Using org-readme::
+* History::
+@end menu
+
+@node Possible Dependencies
+@section Possible Dependencies
+None
+
+@node Using org-readme
+@section Using org-readme
+Org readme is used to:
+
+@itemize
+@item
+Create/Update a "History" section in the Readme.org based on the changelog section of the Emacs Log.
+@item
+Create/Update a "Library Information" Section Based on the Emacs lisp header.
+@item
+Create/Update a "Possible Dependencies" Section Based on the Emacs lisp header.
+@end itemize
+
+All other sections of the Readme.org are then put into the "Commentary" section of the readme.org.
+
+In addition this library defines @code{org-readme-sync}@comma{} a convenience function that:
+
+@itemize
+@item
+Asks for a commentary about the library change.
+@item
+Syncs the Readme.org with the lisp file as described above.
+@item
+Updates emacswiki with the library description and the library itself (requires yaoddmuse).
+@item
+Updates Marmalade-repo if the library version is different than the version in the server (requires http-post-simple).
+@item
+Updates the git repository with the differences that you posted.
+@item
+If you are using github@comma{} this library creates a melpa recipie.
+@item
+If you are using github@comma{} this library creates a el-get recipie.
+@end itemize
+
+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.
+@menu
+* Why each required library is needed::
+@end menu
+
+@node Why each required library is needed
+@subsection 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
+http-post-simple
+Publish to marmalade-repo.org
+header2
+To create header and changelog
+lib-requires
+To generate the library dependencies
+
+@node History
+@section History
+@itemize
+@item
+@strong{13-Aug-2012} -- Another attempt to make texinfo documents. (Matthew L. Fidler)
+@item
+@strong{13-Aug-2012} -- Added texinfo output. Allows native emacs documentation. (Matthew L. Fidler)
+@item
+@strong{13-Aug-2012} -- Tried to post behind firewall. Reattempting. (Matthew L. Fidler)
+@item
+@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)
+@item
+@strong{11-Aug-2012} -- Reverted. Still buggy. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Another attempt at bug fix to remove section. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Another attempt at a remove-section fix. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Bug fix for org-readme version tagging. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Test the bug where some of the section text is deleted (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Added more documentation (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- One last bug fix to the markdown export engine. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Markdown bug fix (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Bug fix for el-get recipe. (Matthew L. Fidler)
+@item
+@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)
+@item
+@strong{11-Aug-2012} -- Bug fix for emacswiki post and melpa bug fix (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Bug fix for adding melpa recipes. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Bug fix for creating melpa recipe. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Added ability to add melpa recipe (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Bug fix for pushing tags to a git repository (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Another fix for git tags. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Found a bug@comma{} let see if tagging works now. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Added Git tagging of new versions. Lets see if it works. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Git push worked. Bumping minor version. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Attempted to push repository again. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Attempt to push with git. Something changed. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Added better Package-Requires tag. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Made request for minor revision earlier@comma{} and fixed bug. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Fixed code typo (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Bug fix for deleting a section of a Readme.org file. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Testing bug. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Minor bug fix. (Matthew L. Fidler)
+@item
+@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)
+@item
+@strong{11-Aug-2012} -- Bug fix for syncing readme. Now the returns should not be as prevalent. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Attempting to post to marmlade again... (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Attempting to fix org-readme-marmalade-post. (Matthew L. Fidler)
+@item
+@strong{11-Aug-2012} -- Bug fix to upload to emacswiki and upload to marmalade-repo (Matthew L. Fidler)
+@item
+@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)
+@item
+@strong{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)
+@item
+@strong{07-Aug-2012} -- To use@comma{} put (require 'ess-smart-underscore) in your ~/.emacs file 7-Aug-2012 Matthew L. Fidler Last-Updated: Mon Aug 13 21:53:20 2012 (-0500)
+@item
+@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)
+@item
+@strong{06-Aug-2012} -- Bug fix for syncing from the single lisp file. (Matthew L. Fidler)
+@item
+@strong{06-Aug-2012} -- Added the ability to call @code{org-readme-sync} from Readme.org (Matthew L. Fidler)
+@item
+@strong{05-Aug-2012} -- Added git pushing to org-readme (Matthew L. Fidler)
+@item
+@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)
+@item
+@strong{04-Aug-2012} -- Added syncing with emacswiki. (Matthew L. Fidler)
+@item
+@strong{04-Aug-2012} -- Initial Release (Matthew L. Fidler)
+@end itemize
+
+@bye

0 comments on commit 0b11701

Please sign in to comment.