amkhlv/  titlepage-init
amkhlv/  slide
amkhlv/  afterpause
amkhlv/  remove
amkhlv/  initialize-formula-collection
amkhlv/  number-for-formula
amkhlv/  ref-formula
amkhlv/  command-to-typeset-formula
amkhlv/  formula
amkhlv/  equation
amkhlv/  js
amkhlv/  js-url
amkhlv/  path-to-link
amkhlv/  elemstyle
amkhlv/  rectangular-table?
amkhlv/  table
amkhlv/  verb
amkhlv/  clr
amkhlv/  longtable
amkhlv/  dir-contains-scrbl?
amkhlv/  list-scrbls
amkhlv/  list-scrbls-in-dir
boldred
amkhlv/  set-url
amkhlv/  www-ribbon
amkhlv/  www-prepend-root

BystroTeX

This manual is only partially useful, because many functions are auto-generated by macros. The beginner user should find the instructions in the form of a slide presentation here, and also study the sample file slides-manual.scrbl, which is in the samples directory. This sample file can be used as a template for creating new presentations.

 (require (planet amkhlv/bystroTeX/slides))

procedure

(amkhlv/titlepage-init)  element?

Installs the titlepage style

procedure

(amkhlv/slide x    
  [#:tag tg    
  #:showtitle sttl]    
  #:rest xs)  part?
  x : content?
  tg : (or/c symbol? string? #f) = #f
  sttl : boolean? = #f
  xs : (listof pre-flow?)
A basic slide. The title of the slide is x, and the contents are xs. I recommend providing a nice tag tg, which will serve as a filename for the html. Otherwize, x will be used as a filename, which may lead to awkward effects.

procedure

(amkhlv/afterpause [#:tag tg] #:rest xs)  part?

  tg : (or/c symbol? string? #f) = #f
  xs : (listof pre-flow?)
The continuation of the slide to be shown after pause.

procedure

(amkhlv/remove)  void?

Removes the most recently shown part of the slide

procedure

(amkhlv/initialize-formula-collection)  db?

This is to initialize the formula collection.

procedure

(amkhlv/number-for-formula x)  string?

  x : string?
Like \label{...} in LaTeX, the label is x.

procedure

(amkhlv/ref-formula x)  string?

  x : string?
Like \ref{...} in LaTeX, reference to the label x.

procedure

(amkhlv/command-to-typeset-formula comm    
  tex    
  n    
  fn)  string?
  comm : path-string?
  tex : string?
  n : number?
  fn : string?
This should not be directly called by the user. Just for reference, comm is the path to an executable, which has the following properties. That executable should take 3 arguments: a LaTeX string tex representing a formula, a number n which is the intended fontsize of the formula, and a string fn which is the filename, which should have extension .png. The executable, upon success, should return a number representing the vertical offset. (Because e.g. letters x and y have different vertical offset.)

procedure

(amkhlv/formula #:database x    
  #:formulas-in-dir y    
  [#:shell-command z]    
  #:size n    
  #:align m    
  #:use-depth ud    
  #:aa-adjust aa-adj    
  #:rest tex)  element?
  x : db?
  y : string?
  z : path? = #f
  n : natural-number/c
  m : (or/c (integer-in (- 99) 99) #f)
  ud : boolean?
  aa-adj : (integer-in (- 99) 99)
  tex : (listof string?)
The user probably will not want to call this procedure directly, because there are various auto-generated shortcuts.

procedure

(amkhlv/equation tex #:size n [#:label l])  nested-flow?

  tex : (listof string?)
  n : natural-number/c
  l : (or/c string? #f) = #f
Display-style formula. But it should not be called directly, because there is a shortcut defined in the headers of the slide file.

 (require (planet amkhlv/bystroTeX/common))

procedure

(amkhlv/js x)  traverse-element?

  x : string?
Javascript injection

procedure

(amkhlv/js-url url)  traverse-element?

  url : string?
Insert Javascript from URL

procedure

(amkhlv/path-to-link x)  string?

  x : string?
Returns the string representing a file URL for the UNIX path represented by x

procedure

(amkhlv/elemstyle x #:rest otherprops)  style?

  x : (or/c #f string?)
  otherprops : (listof any/c)
Style selector for element. Example of use:

(element (amkhlv/elemstyle "vertical-align:middle") (image "flowers-on-the-wall.png"))

The otherprops are as described in the manual of element

procedure

(amkhlv/rectangular-table? l)  boolean?

  l : any
Verifies if l is a list of lists representing a rectangular table

procedure

(amkhlv/table rows #:orient dirn)  table?

  rows : amkhlv/rectangular-table?
  dirn : (or/c 'hor 'vert #f)
To insert a table

procedure

(amkhlv/verb x #:indent i #:rest xs)  block?

  x : string?
  i : exact-nonnegative-integer?
  xs : (listof string?)
Like (verbatim x #:indent i xs) but modified so that copy-past does not introduce extra linebreaks

procedure

(amkhlv/clr colorname #:rest xs)  element?

  colorname : string?
  xs : (listof pre-content?)
Colored text.

procedure

(amkhlv/longtable bss    
  #:styless stylepropsss    
  #:width w)  nested-flow?
  bss : (listof (listof block?))
  stylepropsss : (listof (listof (listof (or/c 'left 'right 'center 'top 'baseline 'bottom 'vcenter))))
  w : (integer-in 1 100)
Produces a tabular structure of width w with cell content bss and cell styles stylepropsss.

procedure

(amkhlv/dir-contains-scrbl? p)  boolean?

  p : path?
Returns #t if the directory p contains a scribble-file

procedure

(amkhlv/list-scrbls p    
  [#:exclude-same-name x])  (listof path?)
  p : path?
  x : boolean? = #t
Return the list of paths to scribble files in the dir p; if x is #t, then exclude the file which has the same name as the source file

procedure

(amkhlv/list-scrbls-in-dir p    
  [#:background-color clr])  element?
  p : path?
  clr : (listof integer?) = '(251 206 177)
A nicely formatted list of links to scribble files in the folder p

procedure

(boldred #:rest x)  element?

  x : (listof pre-content?)
Text in bold red

procedure

(amkhlv/set-url x)  void?

  x : string?
This is for putting pages on my website. Sets the URL of my website.

procedure

(amkhlv/www-ribbon)  table?

This is for putting pages on my website. Formatted list of all the .scrbl files in the current directory, with the URL of my website prepended.

procedure

(amkhlv/www-prepend-root x)  string?

  x : string?
This is for putting pages on my website. Example of use: @hyperlink[@amkhlv/www-prepend-root{writeup.html}]{Link to some writeup}