Scribble localization and manual style questions

19 views
Skip to first unread message

Dexter Lagan

unread,
Jun 21, 2019, 4:10:03 AM6/21/19
to racket...@googlegroups.com

Hi folks,

 

  I hope this is the right group for my questions. The Scribble users Google group seems empty.

I am in the process of writing a commercial application’s manual. This particular app is in French and so should be the manuals.

 

  1. Am I allowed to use scribble/manual to write my manual? I love Scribble the Racket docs style and wish I could use the same style;
  2. By default the scribble/manual style is localized for English: @author prefixes with ‘by’ and appends ‘and’ between authors. The Author and Author+Email functions are hardcoded this way. The ‘author paragraph seems to be writing the prefix ‘by’, but I couldn’t find its definition, and writing a new scheme file just to override the functions and paragraph defs seems overkill. Can I localize this to my language?
  3. By default, scribble/manual displays the Racket version number on top. Is there a way to prevent this, or use my own version number?

 

Thanks in advance,

 

Dexter

Sam Tobin-Hochstadt

unread,
Jun 21, 2019, 10:37:01 AM6/21/19
to Dexter Lagan, Racket Users
On Fri, Jun 21, 2019 at 4:10 AM Dexter Lagan <dexte...@gmail.com> wrote:
>
>
> Am I allowed to use scribble/manual to write my manual? I love Scribble the Racket docs style and wish I could use the same style;

Yes, certainly. Everyone is welcome to use this.

> By default the scribble/manual style is localized for English: @author prefixes with ‘by’ and appends ‘and’ between authors. The Author and Author+Email functions are hardcoded this way. The ‘author paragraph seems to be writing the prefix ‘by’, but I couldn’t find its definition, and writing a new scheme file just to override the functions and paragraph defs seems overkill. Can I localize this to my language?

Currently there's no way to localize this, but the `author` and
`author+email` functions are quite simple. The whole implementation is
here: https://github.com/racket/scribble/blob/54606422140136dbc8f0759f2d44e757a0193ac4/scribble-lib/scribble/base.rkt#L111-L138

The "by" is added in CSS, in the SAuthorList::before rule. That you
can change with a simple custom additional CSS file.

> By default, scribble/manual displays the Racket version number on top. Is there a way to prevent this, or use my own version number?

I usually remove this with CSS as well.

Sam

Dexter Lagan

unread,
Jun 21, 2019, 10:47:36 AM6/21/19
to Sam Tobin-Hochstadt, Racket Users
Great, thanks for the info!

Dex

Matthew Flatt

unread,
Jun 21, 2019, 10:49:03 AM6/21/19
to Sam Tobin-Hochstadt, Dexter Lagan, Racket Users
You can remove it with `#:version ""` in the document's main `title`.

Reply all
Reply to author
Forward
0 new messages