X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-lib.scm;h=182f5812721f34be60a59df1a74bb966fa5f64cc;hb=32a34dcef0c0041c6d62677487a380b5c8b85712;hp=4a25f5420c633a9320d6c4d53dd8e67efe13dac5;hpb=686bdc1c18148f6b4ac0d861d71919167075963b;p=lilypond.git

diff --git a/scm/documentation-lib.scm b/scm/documentation-lib.scm
index 4a25f5420c..182f581272 100644
--- a/scm/documentation-lib.scm
+++ b/scm/documentation-lib.scm
@@ -1,10 +1,20 @@
+;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
-;;;; documentation-lib.scm -- Assorted Functions for generated documentation
-;;;;
-;;;; source file of the GNU LilyPond music typesetter
-;;;; 
-;;;; (c) 2000--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 2000--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;;
+;;;; LilyPond is free software: you can redistribute it and/or modify
+;;;; it under the terms of the GNU General Public License as published by
+;;;; the Free Software Foundation, either version 3 of the License, or
+;;;; (at your option) any later version.
+;;;;
+;;;; LilyPond is distributed in the hope that it will be useful,
+;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;;; GNU General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU General Public License
+;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 
 (use-modules (oop goops)
 	     (srfi srfi-13)
@@ -26,8 +36,8 @@
   (display
    (string-append
     "\n@node "
-    (node-name node)
-    "\n\n"
+    (if (= level 0) "Top" (node-name node))
+    "\n"
     (if (appendix? node)
         (texi-appendix-section-command level)
         (texi-section-command level))
@@ -46,7 +56,7 @@
        (node-children node)))
 
 (define (processing name)
-  (ly:message (_ "Processing ~S...") name))
+  (ly:basic-progress (_ "Processing ~S...") name))
 
 (define (self-evaluating? x)
   (or (number? x) (string? x) (procedure? x) (boolean? x)))
@@ -60,22 +70,22 @@
 
 
 (define (texi-section-command level)
-  (cdr (assoc level '(
-		      ;; Hmm, texinfo doesn't have ``part''
-		      (0 . "@top")
-		      (1 . "@chapter")
-		      (2 . "@section")
-		      (3 . "@subsection")
-		      (4 . "@unnumberedsubsubsec")
-		      (5 . "@unnumberedsubsubsec")))))
+  (assoc-get level '(
+		     ;; Hmm, texinfo doesn't have ``part''
+		     (0 . "@top")
+		     (1 . "@chapter")
+		     (2 . "@section")
+		     (3 . "@subsection")
+		     (4 . "@unnumberedsubsubsec")
+		     (5 . "@unnumberedsubsubsec"))))
 
 (define (texi-appendix-section-command level)
-  (cdr (assoc level '((0 . "@top")
-		      (1 . "@appendix")
-		      (2 . "@appendixsec")
-		      (3 . "@appendixsubsec")
-		      (4 . "@appendixsubsubsec")
-		      (5 . "@appendixsubsubsec")))))
+  (assoc-get level '((0 . "@top")
+		     (1 . "@appendix")
+		     (2 . "@appendixsec")
+		     (3 . "@appendixsubsec")
+		     (4 . "@appendixsubsubsec")
+		     (5 . "@appendixsubsubsec"))))
 
 (define (one-item->texi label-desc-pair)
   "Document one (LABEL . DESC); return empty string if LABEL is empty string."
@@ -100,13 +110,13 @@ string-to-use).  If QUOTE? is #t, embed table in a @quotation environment."
   "Generate what is between @menu and @end menu."
   (let ((maxwid
 	 (apply max (map (lambda (x) (string-length (car x))) items-alist))))
-    
+
     (string-append
      "\n@menu"
      (apply string-append
 	    (map (lambda (x)
 		   (string-append
-		    (string-pad-right 
+		    (string-pad-right
 		     (string-append "\n* " (car x) ":: ")
 		     (+ maxwid 8))
 		    (cdr x)))
@@ -149,12 +159,13 @@ string-to-use).  If QUOTE? is #t, embed table in a @quotation environment."
   name)
 
 (define (ref-ify x)
-  "Add ref to X"
+  "Return @ref{X}.  If mapping ref-ify to a list that needs to be sorted,
+   sort the list first."
   (string-append "@ref{" x "}"))
 
 (define (human-listify lst)
   "Produce a textual enumeration from LST, a list of strings"
-  
+
   (cond
    ((null? lst) "none")
    ((null? (cdr lst)) (car lst))
@@ -164,10 +175,21 @@ string-to-use).  If QUOTE? is #t, embed table in a @quotation environment."
 (define (writing-wip x)
   (ly:message (_ "Writing ~S...") x))
 
+(define (identifier<? a b)
+  (ly:string-ci<?
+   (symbol->string (car a))
+   (symbol->string (car b))))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;; property  stuff.
 
+(define (verify-type-name where sym type)
+  (if (eq? type #f)
+      (ly:error (_ "cannot find description for property `~S' (~S)")
+                sym
+                where))
+  (type-name type))
+
 (define (property->texi where sym . rest)
   "Document SYM for WHERE (which can be translation, backend, music),
 with init values from ALIST (1st optional argument)
@@ -176,23 +198,23 @@ with init values from ALIST (1st optional argument)
 	 (alist (if (pair? rest) (car rest) '()))
 	 (type?-name (string->symbol
 		      (string-append (symbol->string where) "-type?")))
-	 (doc-name (string->symbol		    
+	 (doc-name (string->symbol
 		    (string-append (symbol->string where) "-doc")))
 	 (type (object-property sym type?-name))
-	 (typename (type-name type))
+	 (typename (verify-type-name where sym type))
 	 (desc (object-property sym doc-name))
-	 (handle (assoc sym alist)))
+	 (init-value (assoc-get sym alist)))
 
     (if (eq? desc #f)
 	(ly:error (_ "cannot find description for property ~S (~S)") sym where))
-    
+
     (cons
      (string-append "@code{" name "} "
 		    "(" typename ")"
-		    (if handle
+		    (if init-value
 			(string-append
 			 ":\n\n"
-			 (scm->texi (cdr handle))
+			 (scm->texi init-value)
 			 "\n\n")
 			""))
      desc)))