improving (form) rendering and indexing

Author: jpolitz

scribble-api.rkt

@@ -856,7 +856,9 @@
    (let ([processing-module (curr-module-name)])
      (define part-tag (list 'part (tag-name (curr-module-name) name)))
      (define pyret-text (seclink (xref processing-module name) (pyret text)))
-     (define pyret-elt (toc-target-element code-style (list pyret-text) part-tag))
+     (define pyret-elt (toc-target2-element code-style (list pyret-text) part-tag (list name)))
+     (define part-tags (list 'part (curr-module-name) name))
+     (define index-tags (cons (pyret name) (filter (lambda(e) (not (or (equal? e name) (equal? e "")))) (rest part-tags))))
      (interleave-parbreaks/all
       (list
         (traverse-block ; use this to build xrefs on an early pass through docs
@@ -867,11 +869,20 @@
                (apply para #:style (div-style "boxed pyret-header")
                   (list pyret-elt)))
            (nested #:style (div-style "value")
-                   (cons
-                     header-part
+                   (append
+                     (list
+                      (let ((tag (make-generated-tag)))
+                                (make-index-element #f
+                                                    (list (make-target-element #f '() `(idx ,tag)))
+                                                    `(idx ,tag)
+                                                    (cons name (rest index-tags))
+                                                    index-tags
+                                                    #f))
+                      header-part)
                      (interleave-parbreaks/all
                       (append
-                        (list (nested #:style (div-style "description") contents))))))))))))
+                        (list 
+                          (nested #:style (div-style "description") contents))))))))))))
 
 (define (value name ann #:private (private #f) #:style (style "boxed pyret-header") . contents)
   (when (not private) (set-documented! (curr-module-name) name))

src/builtin/booleans.scrbl

@@ -36,7 +36,7 @@ end
 }
   @section{Boolean Operators}
 
-@form["and" "<left> and <right>"]{
+@form["and" "left and right"]{
   @margin-note{
   The @pyret{and} operator “short-circuits”: if @pyret{left}
   evaluates to @pyret{false}, then @pyret{right} is not evaluated at all and the
@@ -59,7 +59,7 @@ end
   }
 }
 
-@form["or" "<left> or <right>"]{
+@form["or" "left or right"]{
   @margin-note{
   The @pyret{or} operator “short-circuits”: if @pyret{left}
   evaluates to @pyret{true}, then @pyret{right} is not evaluated at all and the

src/builtin/numbers.scrbl

@@ -9,10 +9,10 @@
 @(append-gen-docs
   `(module "numbers"
     (path "src/js/base/runtime-anf.js")
-    (form-spec (name "num+"))
-    (form-spec (name "num-"))
-    (form-spec (name "num*"))
-    (form-spec (name "num/"))
+    (form-spec (name "+ (addition operator)"))
+    (form-spec (name "- (subtraction operator)"))
+    (form-spec (name "* (multiplication operator)"))
+    (form-spec (name "/ (division operator)"))
     (data-spec
       (name "Number")
       (variants)
@@ -433,7 +433,7 @@ The mathematical constant π, approximated as a @pyret-id["Roughnum"], or
 
 @section{Number Operators}
 
-@form["num+" "<left> + <right>"]{
+@form["+ (addition operator)" "left + right"]{
   @margin-note{If either of the values in an arithmetic operator is a
   @pyret{Roughnum}, the result is a @pyret{Roughnum}}
   When @pyret{left} and @pyret{right} evaluate to numbers, adds them and returns
@@ -448,7 +448,7 @@ end
 }
 }
 
-@form["num-" "<left> - <right>"]{
+@form["- (subtraction operator)" "left - right"]{
   When @pyret{left} and @pyret{right} evaluate to numbers, subtracts
   @pyret{right} from @pyret{left} and returns the result.
 
@@ -461,7 +461,7 @@ end
 }
 }
 
-@form["num*" "<left> * <right>"]{
+@form["* (multiplication operator)" "left * right"]{
   When @pyret{left} and @pyret{right} evaluate to numbers, multiplies
   them and returns the result.
 
@@ -474,7 +474,7 @@ end
 }
 }
 
-@form["num/" "<left> / <right>"]{
+@form["/ (division operator)" "left / right"]{
   @margin-note{To be used as an operator, @pyret{/} has to have spaces around
   it. This means you need to write @pyret{a / 3} rather than @pyret{a/3} to
   divide the value stored in @pyret{a} by @pyret{3}. Things like @pyret{4/3} and
@@ -492,6 +492,7 @@ end
 }
 }
 
+
 @section{Number Functions}
 
 @function["num-equal" #:contract (a-arrow N N B) #:return B]{