Questions tagged [scribble]

Scribble is a domain specific language used for documentation in the Racket eco-system.

Scribble is a syntax and a collection of tools for creating prose documents—papers, books, library documentation, etc.—in HTML or PDF (via Latex) form. More generally, the Scribble syntax is useful for programs that are rich in textual content, whether the it is prose to be typeset or any other form of text to be generated programmatically.

Scribble Introductory Video

Scribble: Closing the Book on Ad Hoc Documentation Tools

49 questions
3
votes
1 answer

How do I get scribble to make -- be two short dashes rather than one long dash?

In scribble, when I put two dashes (or even three dashes) together, such as --, it comes out as one long dash. How can I make scribble keep them as two short dashes, such as in this documentation page? My ultimate goal is to be able to turn them…
Leif Andersen
  • 21,580
  • 20
  • 67
  • 100
3
votes
2 answers

how to obtain the path of the current .scrbl file?

Suppose I am running scribble on the file example.scrbl: scribble example.scrbl I want to figure out the path, or at least the name, of the file which is being processed (in this case example.scrbl), programmatically inside the file itself. I…
amkhlv
  • 307
  • 2
  • 14
2
votes
1 answer

In Scribble how can I get the path to the current file being processed?

I'm using Scribble to pull in parts of files that are stored in other files (not written in Racket). Reading the files and getting the content in works fine, but I don't know how to figure out where the file that the function is being invoked is in,…
2
votes
1 answer

How do I mimic the look&feel of Racket docs when I create my own Scribble documents?

I like the look and feel of the Racket documentation, in terms of style. But when I generate my own Scribble documents, the default look is OK, but not quite what I would like in terms of fonts and colors. Where exactly does the styling of the…
gknauth
  • 2,310
  • 2
  • 29
  • 44
2
votes
2 answers

Page numbers in scribble/acmart

I'm creating a pdf with the scribble/acmart language. How can I add page numbers to my document?
Ben Greenman
  • 1,945
  • 12
  • 22
2
votes
1 answer

Scribble: how to center a tabular?

I'm writing a technical paper with Scribble. The paper contains a table. I'm making the table with tabular. So far so good. I want to center the table, but wrapping my tabular with centered has no effect. Help!
Ben Greenman
  • 1,945
  • 12
  • 22
2
votes
0 answers

Trouble using `make-at-reader`-generated function with `include/reader`

Edit: I've identified the problem, and I've found a workaround (see Update 2 at the end), but it seems like there should be a more elecant way to do this — I hope someone can come up with one. I'm running into trouble when trying to use a function…
LiberalArtist
  • 509
  • 4
  • 13
2
votes
1 answer

Change font size in Scribble document

In latex, I can change the overall font size of my document in the \documentclass line. \documentclass[11pt]{lncs} \begin{document} .... \end{document} How can I change the font size of my document using Scribble? One possibility is to use exact…
Leif Andersen
  • 21,580
  • 20
  • 67
  • 100
2
votes
1 answer

Racket: enable scribble language in sub module

#lang racket/base (module x scribble/text @(display 123)) It seems like #lang statements are not valid in nested sub-modules, and the expanded module version above is missing something: error: module: no #%module-begin binding in the module's…
Jean-Baptiste
  • 31
  • 2
  • 11
1
vote
1 answer

Include non-Racket source in Scribble files

I'm writing documentation, and part of it includes small programs written in languages other than Racket. I can of course include them inline (using @verbatim), but I'd like to be able to at least minimally test/run them, so it'd be much more…
1
vote
1 answer

Scribble uses too much memory?

"scribble" is the racket documentation tool. I have got a problem with the following example. When N=30, scribble uses ~500M memory. It seems very difficult to have more than 300 such examples in a single scribble document. cat <
wcy
  • 875
  • 11
  • 12
1
vote
0 answers

Scribble documentation --- PDF CREATION ERROR

I am trying to generate a pdf file from scribble, but I got the following error message. Code This is the simple toy example on which I am trying to generate the pdf. #lang scribble/base @title{Discourse} @author{Racket} Error: Here is how much of…
jordy
  • 13
  • 3
1
vote
1 answer

Howto include file content in a Scribble document

I am using Scribble to write assignments and would like to have the ability to include common text snippets somewhere in the document. For example: #lang scribble/manual @section{Some section} @include-file["common-pretext.scrbl"] @; my imaginary…
terminal
  • 105
  • 1
  • 8
1
vote
1 answer

Having trouble compiling scribble document with `#lang scribble/html`

I'm trying to use Scribble (Racket v8.0 [cs]) to generate some HTML using #lang scribble/html and I've reduced my source file to only the lang statement (to isolate other issues): #lang scribble/html To run the code I'm using terminal: % scribble…
Josh Grant
  • 471
  • 4
  • 15
1
vote
1 answer

How do I link to third party Racket docs in Scribble?

I'm attempting to link to Scribble docs provided by a third party (as opposed to core) library (specifically, data/collection), but I'm having trouble getting it to work. With these imports: @require[scribble/manual scribble-abbrevs/manual …
mindthief
  • 12,755
  • 14
  • 57
  • 61