Browse Source

Merge branch 'master' of git+ssh://repo.or.cz/srv/git/Worg

Jason Dunsmore 9 years ago
parent
commit
ae1b835a66
5 changed files with 97 additions and 70 deletions
  1. 2 2
      org-contrib/index.org
  2. 14 3
      org-contribute.org
  3. 63 60
      org-faq.org
  4. 10 1
      org-mailing-list.org
  5. 8 4
      org-tutorials/org-latex-export.org

+ 2 - 2
org-contrib/index.org

@@ -20,8 +20,8 @@ extensive than what is available in the manual.  If no documentation
 link is present, see the file header of the package -- it will
 hopefully have some documentation.
 
-- /org-annotate-file.el/ -- annotate a file with org syntax ::
-  The annotation is in a separate file, with links back to the
+- /org-annotate-file.el/ -- annotate a file with org syntax :: The 
+  annotation is in a separate file, with links back to the
   annotated file.  Written by /Philip Jackson/.
   [[repofile:contrib/lisp/org-annotate-file.el][Link to raw file]].
 

+ 14 - 3
org-contribute.org

@@ -90,9 +90,20 @@ provides an amazing framework to collaborate on a project.  Git can be used
 to make patches and send them via email -- this is perfectly fine for minor
 changes.
 
-These patches will be automatically registered at [[http://patchwork.newartisans.com/project/org-mode][John Wiegley's patchwork
-server]] and will then be accepted, rejected, or sent back to the author with
-a request for modification.
+As long as these patches are formatted properly, they will be
+automatically registered at [[http://patchwork.newartisans.com/project/org-mode][John Wiegley's patchwork server]] and will
+then be accepted, rejected, or sent back to the author with a request
+for modification. In this context, "formatted properly" means that the
+patches are included either plainly in the mail text, or as text
+attachments (mime-type text, subtypes "x-patch", "x-diff", or
+"plain"). In particular, binary types or, even worse,
+"application/octet-stream" (the asinine default of some mail programs)
+are *not* going to be recognized. Please find out how to convince your
+mail program to send proper attachments. Also, if you include the
+patch inline, please make sure that your mail program does not
+reformat it (although there are plenty of places further down the line
+where that can happen, unfortunately). If you attach the patch, then
+reformatting is not a problem.
 
 ** Sending quick fixes
 

+ 63 - 60
org-faq.org

@@ -172,7 +172,7 @@ possession of the Org-mode author.
 ** Is Org's documentation written in Org?
 
 No.  Org's documentation is written in TeXinfo, which is the standard
-format for Emacs documentation.  There is no export mechanism from Org 
+format for Emacs documentation.  There is no export mechanism from Org
 to TeXinfo (yet).
 * Mailing list
 ** I think my Org-mode is broken! How do I report a bug?
@@ -194,7 +194,7 @@ to TeXinfo (yet).
 
       - Some users call this an "[[#ecm][ECM]]", a French acronym that means a
         "complete minimal example".
-      
+
 ** What is an "ECM"?
    :PROPERTIES:
    :CUSTOM_ID: ecm
@@ -223,7 +223,7 @@ that demonstrates the bug. See [[http://permalink.gmane.org/gmane.emacs.orgmode/
    already been discussed.
 
    See [[#can-org-do-x][this faq]] for more details.
-   
+
 ** Why hasn't my email to the mailing list shown up yet?
    :PROPERTIES:
    :CUSTOM_ID: ml-post-delay
@@ -573,7 +573,7 @@ The result of that discussion is the file/function found in
 
    Daily builds of Org-mode is distributed as an ELPA package from
    both [[http://elpa.gnu.org/packages/][GNU Emacs Lisp Package Archive]] as well as from [[http://orgmode.org/pkg/daily/][Org-mode Emacs
-   Lisp Archive]].  
+   Lisp Archive]].
 
    Steps for installing Org with package manager:
    1) Do =M-x list-packages= to browse available packages
@@ -609,10 +609,10 @@ The result of that discussion is the file/function found in
    :PROPERTIES:
    :CUSTOM_ID: installing-elpa
    :END:
-   
+
    If you are running Emacs 24 or find the command =M-x list-packages=
    available you already have the package manager installed.
-   
+
    Steps for installing package manager on emacs-23:
    1. Download the package manager [[http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el][package.el]]
 
@@ -620,43 +620,43 @@ The result of that discussion is the file/function found in
       #+begin_src emacs-lisp
         ;; change "~/elisp/" as appropiate
         (setq load-path (cons "~/elisp" load-path))
-        
+
         ;; Add the below lines *at the end* of your .emacs. This
         ;; ensures that packages installed with package manager
         ;; overrides other local installation
         (require 'package)
         (package-initialize)
       #+end_src
-   
+
 ** I don't see Org-mode as an installation option in Package Manager Menu?
    :PROPERTIES:
    :CUSTOM_ID: why-no-org-in-elpa
    :END:
-   
+
    Emacs Package Manager is a very recent addition to Emacs. Work is
    under way to have have Org-mode seamlessly integrate with Emacs'
    Package Manager. As a result, it will be some time before the
    Org-mode packages are available and usable from either GNU or
    Org-mode package archives.
-   
+
    In the meanwhile, you can install Org-mode via package manager
    through ELPA-compatible tar. Refer [[Installing from ELPA-tar][this FAQ entry]] for more information.
-   
+
 ** How do I install Org-mode from a ELPA-compatible tarball?
    :PROPERTIES:
    :CUSTOM_ID: installing-from-elpa-tarball
    :END:
 # <<Installing from ELPA-tar>>
-   
+
    Org-mode is distributed as an ELPA-compatible tar which can be used
    in conjunction with Emacs' package manager.
-   
+
    1. If you are already running Org-mode, note the current version
       reported by M-x org-version.
    2. Download the latest tarball from [[http://orgmode.org/pkg/daily/][Org-mode repo]].
    3. Do =M-x package-install-file=. When prompted for =Package file
       name=, point it to .tar file downloaded in step 2.
-      
+
       You will now see Package Manager compiling the files and
       installing it.
    4. Reload emacs. This step is very important.
@@ -670,22 +670,22 @@ The result of that discussion is the file/function found in
       =~/.emacs.d/elpa/...=). Fix this anamoly by moving
       =(package-initialize)= line in .emacs to a more appropriate
       location.
-      
+
    - Additional Note on =org-install.el= :: Functionality of Org-mode's
      =org-install.el= is supplanted by Package Manager's
      =org-autoloads.el=. Since Package Manager autoloads Org-mode for
      you, the following line =(require 'org-install)= in your =.emacs=
      is no longer required and can be safely removed.
-     
+
 ** Why would I use ELPA tarballs instead of the snapshot tarballs?
    :PROPERTIES:
    :CUSTOM_ID: why-elpa
    :END:
-   
+
    ELPA-tarballs automate much the process of upgrading org-mode. Much
    of the following grunt work is done automatically by the Package
    Manager:
-   
+
    1. Downloading, compiling, and activating of org-mode (including
       setting org-mode's =load-path= and autoloads).
    2. Updating info files.
@@ -1169,7 +1169,7 @@ Here are some other ideas for speeding up the agenda:
    installation directory.
 
 5. Limit your agenda files (=org-agenda-files=) to files that have
-   active todos and or projects. 
+   active todos and or projects.
 
    If you have a number of older reference files---i.e., files you
    search only occasionally---in your agenda files list, consider
@@ -1304,7 +1304,7 @@ You can add the following to your =.emacs=:
    :END:
 
 Can I have nested, closed outline sections, similar to xml? This
-question comes up quite frequently on the mailing list. 
+question comes up quite frequently on the mailing list.
 
 See the following threads:
 
@@ -1317,19 +1317,19 @@ The desired behavior looks something like this:
 
 #+begin_src org
   ,* Section one
-  
+
   ,Some text
-  
+
   ,** Subsection one
-  
+
   ,Some text
-  
+
   ,** Subsection two
-  
+
   ,Some text
-  
+
   ,# end Subsection Two
-  
+
   ,Continue text in section one.
 #+end_src
 
@@ -1344,6 +1344,9 @@ Here are some workarounds:
    distribution.
 2. You can create a temporary heading, such as "** Continue main
    section" and then remove it when you are ready to export.
+3. You can create a separate outline heading (e.g., * ACTIONS),
+   creating TODOs there with links to the relevant sections of your
+   main text.
 
 ** Can I add a TODO to a list item?
    :PROPERTIES:
@@ -1351,14 +1354,14 @@ Here are some workarounds:
    :END:
 
 No. When generating agenda views, org-mode treats only headlines as
-TODO items. 
+TODO items.
 
 You can, however, use a status cookie together with checkboxes to
 monitor your progress on a series of subtasks:
 
 #+begin_src org
   ,** TODO Big task [1/3]
-  
+
   ,   - [X] Subtask 1
   ,   - [ ] Subtask 2
   ,   - [ ] Subtask 3
@@ -1367,7 +1370,7 @@ monitor your progress on a series of subtasks:
 If you would like to embed a TODO within text without treating it as
 an outline heading, you can use inline tasks. Simply add...
 
-: (require 'org-inlinetask) 
+: (require 'org-inlinetask)
 
 ...to your =.emacs= and then type C-c C-x C-t to insert an inline task.
 
@@ -1678,7 +1681,7 @@ completion using your preferred Emacs method for finding files.
 
 The usual way of turning radio links invisible is to comment them, but
 Org comments need to be at the beginning of the line, which breaks list
-indentation.  
+indentation.
 
 The workaround here is to add (INVISIBLE) after your <<target>>
 
@@ -2309,7 +2312,7 @@ are several possible shortcuts you can use to enter them:
    - Skeletons offer a simple way of automatically entering text.
      Here's a skeleton that queries for the type of block and wraps
      the active region inside it:
- 
+
      #+begin_src elisp
        (define-skeleton skel-org-block
 	 "Insert an org block, querying for type."
@@ -2648,9 +2651,9 @@ and all of its subdirectories to your list of agenda files.
 If on a *nix machine, you can also use the find utility, which can be
 faster than the find-lisp library:
 
-: (setq org-agenda-files 
-:       (mapcar 'abbreviate-file-name 
-:               (split-string 
+: (setq org-agenda-files
+:       (mapcar 'abbreviate-file-name
+:               (split-string
 :                (shell-command-to-string "find ~/org -name \"*.org\"") "\n")))
 
 
@@ -2887,9 +2890,9 @@ If you would prefer not to place the timestamp in the headline, you
 can use the following format:
 
 #+begin_src org
-  ,** Class 
+  ,** Class
   ,%%(org-diary-class 2 16 2009 4 20 2009 1 10) 7:00pm-9:00pm Class
-  
+
 #+end_src
 
 In this case, the string following the sexp will be displayed in the
@@ -3121,7 +3124,7 @@ options]].
 
 You can set unique export options for a [[#export-single-subtree][single subtree]] by using
 properties. Relevant properties include:
- 
+
  - EXPORT_TITLE
  - EXPORT_AUTHOR
  - EXPORT_DATE
@@ -3280,7 +3283,7 @@ Now, you can mark up the abstract of your article like this:
 : #+BEGIN_ABSTRACT
 : Falling apples were observed and compared with pears. Newton's laws
 : were confirmed at the 95% confidence level.
-: #+END_ABSTRACT 
+: #+END_ABSTRACT
 
 Exporting to Latex wraps this in a
 =\begin{abstract}....\end{abstract}= environment, which just works.
@@ -3560,7 +3563,7 @@ tangling the LaTeX preamble and postamble, before
 documents. XeTeX can use any fonts installed in the operating system
 without configuring TeX font metrics, and can make direct use of
 advanced typographic features of OpenType and other font formats. By
-default, org-mode exports =org= files to =pdf= via pdfLaTeX. 
+default, org-mode exports =org= files to =pdf= via pdfLaTeX.
 
 Here is one way to smoothly incorporate XeLaTeX into org-mode's export
 process. This solution takes advantage of [[http://www.phys.psu.edu/~collins/software/latexmk-jcc][latexmk]], a perl script that
@@ -3577,15 +3580,15 @@ you should rename or remove it. Then you can put the following in your
 #+begin_src emacs-lisp
   (require 'org-latex)
   (setq org-export-latex-listings t)
-  
+
   ;; Originally taken from Bruno Tavernier: http://thread.gmane.org/gmane.emacs.orgmode/31150/focus=31432
-  ;; but adapted to use latexmk 4.20 or higher.  
+  ;; but adapted to use latexmk 4.20 or higher.
   (defun my-auto-tex-cmd ()
     "When exporting from .org with latex, automatically run latex,
        pdflatex, or xelatex as appropriate, using latexmk."
     (let ((texcmd)))
     ;; default command: oldstyle latex via dvi
-    (setq texcmd "latexmk -dvi -pdfps -quiet %f")        
+    (setq texcmd "latexmk -dvi -pdfps -quiet %f")
     ;; pdflatex -> .pdf
     (if (string-match "LATEX_CMD: pdflatex" (buffer-string))
         (setq texcmd "latexmk -pdf -quiet %f"))
@@ -3594,16 +3597,16 @@ you should rename or remove it. Then you can put the following in your
         (setq texcmd "latexmk -pdflatex=xelatex -pdf -quiet %f"))
     ;; LaTeX compilation command
     (setq org-latex-to-pdf-process (list texcmd)))
-  
+
   (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-cmd)
-  
-  
+
+
   ;; Specify default packages to be included in every tex file, whether pdflatex or xelatex
   (setq org-export-latex-packages-alist
         '(("" "graphicx" t)
               ("" "longtable" nil)
               ("" "float" nil)))
-    
+
   (defun my-auto-tex-parameters ()
         "Automatically select the tex packages to include."
         ;; default packages for ordinary latex or pdflatex export
@@ -3619,7 +3622,7 @@ you should rename or remove it. Then you can put the following in your
                 (""     "latexsym"  t)
                 (""     "amssymb"   t)
                 (""     "hyperref"  nil)))
-    
+
         ;; Packages to include when xelatex is used
         (if (string-match "LATEX_CMD: xelatex" (buffer-string))
             (setq org-export-latex-default-packages-alist
@@ -3632,7 +3635,7 @@ you should rename or remove it. Then you can put the following in your
                     ("" "soul" t)
                     ("xetex" "hyperref" nil)
                     )))
-        
+
         (if (string-match "LATEX_CMD: xelatex" (buffer-string))
             (setq org-export-latex-classes
                   (cons '("article"
@@ -3642,9 +3645,9 @@ you should rename or remove it. Then you can put the following in your
                           ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
                           ("\\paragraph{%s}" . "\\paragraph*{%s}")
                           ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
-                        org-export-latex-classes))))  
-      
-  (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-parameters)  
+                        org-export-latex-classes))))
+
+  (add-hook 'org-export-latex-after-initial-vars-hook 'my-auto-tex-parameters)
 #+end_src
 
 The =my-auto-tex-cmd= function looks at your =.org= file and checks
@@ -3662,22 +3665,22 @@ are always included in the header of latex documents, regardless of
 how they are compiled. The variable
 =org-export-latex-default-packages-alist= adds additional packages
 depending on whether latex/pdflatex or xelatex is being used. You can
-change the content of these as needed. 
+change the content of these as needed.
 
 Finally, the =org-export-latex-classes= variable redefines elements of
 the =.tex= file's preamble for the xelatex case. These can also be
-customized as needed. 
+customized as needed.
 
 By way of example, an =.org= file you want compiled with xelatex might
 contain the following header:
 
 : #+TITLE: My Paper
 : #+AUTHOR: Jane Doe
-: #+DATE: 
+: #+DATE:
 : #+OPTIONS: toc:nil num:nil
 : #+LATEX_CMD: xelatex
-: #+LATEX_HEADER: \setsansfont[Mapping=tex-text]{Unit-Bold} 
-: #+LATEX_HEADER: \setmonofont[Mapping=tex-text,Scale=MatchLowercase]{PragmataPro} 
+: #+LATEX_HEADER: \setsansfont[Mapping=tex-text]{Unit-Bold}
+: #+LATEX_HEADER: \setmonofont[Mapping=tex-text,Scale=MatchLowercase]{PragmataPro}
 : #+LATEX_HEADER: \setromanfont[Mapping=tex-text,Numbers=OldStyle]{Minion Pro}
 
 If you always want to have the same font setup in your xelatex
@@ -3749,7 +3752,7 @@ There are two approaches:
   - Outline Numbering and Table Of Contents
   - Special markups for elements like TODOs, Timestamps and Tags
 
-- Use existing exporters 
+- Use existing exporters
 
   Export to one of org-mode's supported export formats and then use an
   external tool or method to convert the exported file to doc or odt.
@@ -3796,7 +3799,7 @@ find $HOME -type f -name '*\.org' ! -path "$HOME/org/*" \
 
 It will recursively search for =org= files in your =$HOME= directory
 (except those in =~/org/backup/=) and copy them to =~/org/backup/=.
-You can then use rsync to make sure =~/org/backup/= also lives on a 
+You can then use rsync to make sure =~/org/backup/= also lives on a
 remote and safe place.
 
 * MobileOrg
@@ -3852,7 +3855,7 @@ hooks take care of moving files to and from the WebDAV directory using
 * Mathjax
 
 ** How to install MathJax on my server?
-   
+
 :PROPERTIES:
 :CUSTOM_ID: install_mathjax_on_server
 :END:

+ 10 - 1
org-mailing-list.org

@@ -26,6 +26,15 @@ The [[http://lists.gnu.org/mailman/listinfo/emacs-orgmode][Org mailing list]] is
 </form>
 #+END_HTML
 
+* What to do before posting a question
+
+ Please see the following FAQs:
+
+   - [[file:org-faq.org::#can-org-do-x][Can Org-mode do "x"? Does org have "x" feature?]]
+   - [[file:org-faq.org::#when-to-contact-mailing-list][What should I do before contacting the mailing list?]]
+   - [[file:org-faq.org::#ml-subscription-and-gmane][I read the mailing list through gmane. Should I subscribe?]]
+   - [[file:org-faq.org::#bug-reporting][I think my Org-mode is broken! How do I report a bug?]]
+
 * COMMENT Last messages from the mailing list
 
 #+BEGIN_HTML
@@ -53,7 +62,7 @@ if ( $url1 )
 #+END_HTML
 
 * Statistics (as of sept. 19th 2010)
-
+  
 ** Scope and method
 
 Here are a few stats that I computed from the [[ftp://lists.gnu.org/emacs-orgmode/][lists.gnu.org]] server

+ 8 - 4
org-tutorials/org-latex-export.org

@@ -219,13 +219,17 @@ like this in =.emacs=:
 
 Alternatively, export classes can be defined on a per-file basis in a
 source code block that is evaluated prior to LaTeX export.  This is
-perhaps the most flexible way to set up LaTeX export.  Here is an
-example:
+perhaps the most flexible way to set up LaTeX export.  Since the
+=add-to-list= is a globally side-effecting action, this
+example only calls it if it would add a LaTeX class that isn't
+already on the =org-export-latex-classes= list:
 
 #+begin_example 
   #+source: setup
-  #+begin_src emacs-lisp :results silent
-    (add-to-list 'org-export-latex-classes
+  #+begin_src emacs-lisp :results silent :exports none
+ (unless (find "per-file-class" org-export-latex-classes :key 'car
+           :test 'equal)
+   (add-to-list 'org-export-latex-classes
             '("per-file-class"
                "\\documentclass{scrartcl}
                [NO-DEFAULT-PACKAGES]