defs.rkt 2.05 KB
Newer Older
Robert Ricci's avatar
Robert Ricci committed
1
#lang racket/base
Robert Ricci's avatar
Robert Ricci committed
2
(require scribble/base)
3 4 5
(require scribble/decode)
(require racket/class)
(require racket/draw)
6 7
(require racket/system)
(require racket/port)
8
(require racket/vector)
Robert Ricci's avatar
Robert Ricci committed
9 10 11

(provide (all-defined-out))

12 13 14 15 16 17
; Check to see if we are building Apt or CloudLab documentation
(define tb-mode 
  (if (vector-member "cloudlab" (current-command-line-arguments))
    'cloudlab
    'apt))

18 19
(define apt-base-url "https://www.aptlab.net/")

20
(define tb (lambda () (if (equal? tb-mode 'cloudlab) "CloudLab" "Apt")))
21

22 23 24 25
; We want the 'version' to be the date of the most recent commit
(define apt-version
  (with-output-to-string
    (lambda () (system "git show -s --date=short --format='%cd (%h)' HEAD"))))
26

27 28
; Arbitrary width that works reasonably well with the manual class's main
; column width
29 30 31 32 33 34
(define screenshot-width 650)

(define apturl
  (case-lambda
    [() apt-base-url]
    [(page) (string-append apt-base-url page)]))
Robert Ricci's avatar
Robert Ricci committed
35

36
(define (TODO . what)
37
  (bold "TODO: " (decode-content what)))
38 39 40 41 42 43 44 45

(define nodetype
  (lambda (typename howmany . properties)
          (tabular #:style 'boxed #:sep (hspace 3)
                   (cons
                     (list (bold typename)
                           (string-append (number->string howmany) " nodes"))
                     properties))))
46

47 48 49 50 51 52 53 54
(define (screenshot path)
  (let* ([fullpath (string-append "screenshots/" path)]
         [b (make-object bitmap% fullpath)]
         [width (send b get-width)]
         [scale-factor (/ screenshot-width width)])
    (list (image #:scale scale-factor fullpath fullpath) (linebreak))))

(define (instructionstep step #:screenshot [screenshot-path #f] . body)
55 56
  (item (bold (decode-content (list step)))
        (linebreak)
57 58
        (if screenshot-path
          (screenshot  screenshot-path)
59 60
          (void))
        (decode-content body)))
61 62 63

(define (under-construction)
  (bold "This section is under construction"))
64 65 66 67 68

(define (future-work tag)
  (margin-note "There are planned features relating to this section: see \""
               (secref tag)
               "\" for more details."))
69 70 71

(define (ssh)
  (tt "ssh"))