X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocument-markup.scm;h=35347ae15083c0fac3c47c416c05857f88d4b37b;hb=2fef7b7eb7ac5d7a2ed237bf22a6ec6fe5d946d9;hp=7ff76fa3f77dd188a5942c0d7f4642f9f95acef4;hpb=437ef6151c1c3d2d5ebdb21c37ff51a007623ad2;p=lilypond.git

diff --git a/scm/document-markup.scm b/scm/document-markup.scm
index 7ff76fa3f7..35347ae150 100644
--- a/scm/document-markup.scm
+++ b/scm/document-markup.scm
@@ -1,51 +1,128 @@
+;;;; This file is part of LilyPond, the GNU music typesetter.
+;;;;
+;;;; Copyright (C) 1998--2015 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/>.
 
-(define (doc-markup-function func)
-  (let*
-      (
-       (doc-str  (procedure-documentation func) )
-       (f-name (symbol->string (procedure-name  func)))
-       (sig (object-property func 'markup-signature))
-       (sig-str (string-join (map type-name sig) " "))
-       )
-    
-    
-       
-  (string-append
-   "\n\n@b{"
-   f-name
-   "}\n\n@findex " f-name "\n"
-   "\n\n@i{Argument types}: " sig-str
-   (if (string? doc-str)
-       (string-append
-	"\n\n@i{Description}: \n\n"
-	doc-str)
-       "")
-   
-   
-  )))
-
-(define (markup-function<? a b)
-  (string<? (symbol->string (procedure-name a)) (symbol->string (procedure-name b))))
-
-(define (markup-doc-node)
-  (make <texi-node>
-    #:name "Markup functions"
-    #:desc "Definitions of the markup functions."
 
+(define (doc-markup-function-properties func)
+  (let ((properties (hashq-ref markup-functions-properties func))
+        (prop-strings (list)))
+    (for-each (lambda (prop-spec)
+                (set! prop-strings
+                      (if (list? prop-spec)
+                          ;; either (prop value) or (prop)
+                          (cons (if (null? (cdr prop-spec))
+                                    (format #f "@item @code{~a}\n" (car prop-spec))
+                                    (format #f "@item @code{~a} (~a)\n"
+                                            (car prop-spec)
+                                            (let ((default (cadr prop-spec)))
+                                              (if (and (list? default)
+                                                       (null? default))
+                                                  "'()"
+                                                  default))))
+                                prop-strings)
+                          ;; a markup command: get its properties
+                          ;; FIXME: avoid cyclical references
+                          (append (doc-markup-function-properties prop-spec)
+                                  prop-strings))))
+              (or properties (list)))
+    prop-strings))
 
-    #:text (apply string-append
-		  
-		  "A @code{\\markup} mode command, eg. @code{bold}, is
-coupled with a Scheme function (@code{bold-markup}) implementing the
-formatting.  For use in Scheme, a function @code{make-bold-markup} is
-also defined, which constructs a Markup expression.
+(define (doc-markup-function func)
+  (let* ((full-doc (procedure-documentation func))
+         (match-args (and full-doc (string-match "^\\([^)]*\\)\n" full-doc)))
+         (arg-names (if match-args
+                        (with-input-from-string (match:string match-args) read)
+                        (circular-list "arg")))
+         (doc-str (if match-args (match:suffix match-args) full-doc))
+         (f-name (symbol->string (procedure-name  func)))
+         (c-name (regexp-substitute/global #f "-markup(-list)?$" f-name  'pre "" 'post))
+         (sig (object-property func 'markup-signature))
+         (sig-type-names (map type-name sig))
+         (signature-str
+          (string-join
+           (map (lambda (x y)
+                  (format #f "@var{~a} (~a)" x y))
+                arg-names  sig-type-names)
+           " " )))
 
-This chapter describes all of the @code{...-markup} functions.
+    (string-append
+     "\n\n@item @code{\\" c-name "} " signature-str
+     "\n@funindex \\" c-name "\n"
+     "\n@cindex \\" c-name "\n"
+     (if (string? doc-str)
+         doc-str
+         "")
+     (let ((prop-strings (doc-markup-function-properties func)))
+       (if (null? prop-strings)
+           "\n"
+           (string-append "\n\n\nUsed properties:\n@itemize\n"
+                          (string-concatenate prop-strings)
+                          "@end itemize\n"))))))
 
-"
+(define (markup-function<? a b)
+  (ly:string-ci<? (symbol->string (procedure-name a)) (symbol->string (procedure-name b))))
 
-		  (map doc-markup-function
-		       (sort markup-function-list markup-function<?) ))
-    ))
+(define (markup-category-doc-node category)
+  (let* ((category-string (symbol->string category))
+         (category-name (string-capitalize
+                         (regexp-substitute/global
+                          #f "-" category-string 'pre " " 'post)))
+         (markup-functions (hash-fold (lambda (markup-function dummy functions)
+                                        (cons markup-function functions))
+                                      '()
+                                      (hashq-ref markup-functions-by-category
+                                                 category))))
+    (make <texi-node>
+      #:appendix #t
+      #:name category-name
+      #:desc ""
+      #:text (string-append
+              "@table @asis"
+              (string-concatenate
+               (map doc-markup-function
+                    (sort markup-functions markup-function<?)))
+              "\n@end table"))))
 
+(define (markup-doc-node)
+  (make <texi-node>
+    #:appendix #t
+    #:name "Text markup commands"
+    #:desc ""
+    #:text "The following commands can all be used inside @code{\\markup @{ @}}."
+    #:children (let* (;; when a new category is defined, update `ordered-categories'
+                      (ordered-categories '(font align graphic music instrument-specific-markup accordion-registers other))
+                      (raw-categories (hash-fold (lambda (category functions categories)
+                                                   (cons category categories))
+                                                 (list)
+                                                 markup-functions-by-category))
+                      (categories (append ordered-categories
+                                          (filter (lambda (cat)
+                                                    (not (memq cat ordered-categories)))
+                                                  raw-categories))))
+                 (map markup-category-doc-node categories))))
 
+(define (markup-list-doc-string)
+  (string-append
+   "@table @asis"
+   (string-concatenate
+    (map doc-markup-function
+         (sort (hash-fold (lambda (markup-list-function dummy functions)
+                            (cons markup-list-function functions))
+                          '()
+                          markup-list-functions)
+               markup-function<?)))
+   "\n@end table"))