doc style adjustments; reorg cmdline+editors docs in Guide
This commit is contained in:
Matthew Flatt
parent
a0ba7eb10c
commit
f082919f0b
39
collects/scribblings/guide/cmdline.scrbl
Normal file
39
collects/scribblings/guide/cmdline.scrbl
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
#lang scribble/manual
|
||||
@(require (only-in xrepl/doc-utils [cmd xreplcmd])
|
||||
"guide-utils.rkt")
|
||||
|
||||
@(define xrepl-doc '(lib "xrepl/xrepl.scrbl"))
|
||||
|
||||
@title[#:tag "cmdline-tools"]{Command-Line Tools}
|
||||
|
||||
Racket provides, as part of its standard distribution, a number of
|
||||
command-line tools that can make racketeering more pleasant.
|
||||
|
||||
@; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
@include-section["compile.scrbl"] @; raco
|
||||
|
||||
@; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
@section{Interactive evaluation: XREPL}
|
||||
|
||||
The Racket distribution includes @seclink[#:doc xrepl-doc
|
||||
"top"]{XREPL} (eXtended REPL), which provides everything you expect
|
||||
from a modern interactive environment. For example, XREPL provides an
|
||||
@xreplcmd{enter} command to have a REPL that runs in the context of a
|
||||
given module, and an @xreplcmd{edit} command to invoke your editor (as
|
||||
specified by the @envvar{EDITOR} environment variable) on the file you
|
||||
entered. A @xreplcmd{drracket} command makes it easy to use your
|
||||
favorite editor to write code, and still have DrRacket at hand to try
|
||||
things out.
|
||||
|
||||
For more information about XREPL, see @other-doc[xrepl-doc].
|
||||
|
||||
@; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
@section{Bash completion}
|
||||
|
||||
Shell auto-completion for @exec{bash} is available in
|
||||
@filepath{collects/meta/contrib/completion/racket-completion.bash}.
|
||||
To enable it, just run the file from your @tt{.bashrc}.
|
||||
|
||||
The @filepath{meta} collection is only available in the Racket Full
|
||||
distribution. The completion script is also available
|
||||
@hyperlink["https://raw.github.com/plt/racket/master/collects/meta/contrib/completion/racket-completion.bash"]{online}.
|
||||
|
|
@ -1,14 +1,11 @@
|
|||
#lang scribble/doc
|
||||
@(require scribble/manual "guide-utils.rkt")
|
||||
|
||||
@title[#:tag "compile"]{Compilation and Configuration}
|
||||
@title[#:tag "compile"]{Compilation and Configuration: @exec{raco}}
|
||||
|
||||
So far in this guide, we have mainly discussed DrRacket and
|
||||
@exec{racket} (and @exec{gracket}). The main additional executable is
|
||||
@exec{raco}, which is short for ``@bold{Ra}cket @bold{co}mmand.'' The
|
||||
@exec{raco} program provides a command-line interface to many
|
||||
additional tools for compiling Racket programs and maintaining a
|
||||
Racket installation.
|
||||
The @exec{raco} (short for ``@bold{Ra}cket @bold{co}mmand'') program
|
||||
provides a command-line interface to many additional tools for
|
||||
compiling Racket programs and maintaining a Racket installation.
|
||||
|
||||
@itemize[
|
||||
|
||||
|
|
@ -32,7 +29,7 @@ Racket installation.
|
|||
called @filepath{take-over}, and you'd like to build all bytecode and
|
||||
documentation for the collection, then run
|
||||
|
||||
@commandline{raco setup -l take-over}}
|
||||
@commandline{raco setup take-over}}
|
||||
|
||||
|
||||
@item{@exec{raco planet} manages packages that are normally
|
||||
|
|
|
|||
|
|
@ -1,8 +1,6 @@
|
|||
#lang scribble/base
|
||||
@(require scribble/manual "guide-utils.rkt")
|
||||
|
||||
@(define r6rs @elem{R@superscript{6}RS})
|
||||
@(define r5rs @elem{R@superscript{5}RS})
|
||||
@(require scribble/manual
|
||||
"guide-utils.rkt")
|
||||
|
||||
@title[#:tag "dialects" #:style 'toc]{Dialects of Racket and Scheme}
|
||||
|
||||
|
|
@ -83,7 +81,7 @@ language via @seclink["top" #:doc '(lib
|
|||
Standard dialects of Scheme include the ones defined by @|r5rs| and
|
||||
@|r6rs|.
|
||||
|
||||
@subsection{@|r5rs|}
|
||||
@subsection[#:tag "r5rs"]{@|r5rs|}
|
||||
|
||||
``@|r5rs|'' stands for @link["../r5rs-std/index.html"]{The
|
||||
Revised@superscript{5} Report on the Algorithmic Language Scheme}, and
|
||||
|
|
|
|||
|
|
@ -1,65 +1,71 @@
|
|||
(module guide-utils racket/base
|
||||
(require scribble/manual
|
||||
scribble/struct
|
||||
scribble/decode
|
||||
scribble/eval
|
||||
"../icons.rkt")
|
||||
#lang at-exp racket/base
|
||||
|
||||
(require (for-label racket/base))
|
||||
(provide (for-label (all-from-out racket/base)))
|
||||
(require scribble/manual
|
||||
scribble/struct
|
||||
scribble/decode
|
||||
scribble/eval
|
||||
"../icons.rkt")
|
||||
|
||||
(provide Quick Racket HtDP
|
||||
tool
|
||||
moreguide
|
||||
guideother
|
||||
refalso
|
||||
refdetails
|
||||
refdetails/gory
|
||||
refsecref
|
||||
ext-refsecref)
|
||||
(require (for-label racket/base))
|
||||
(provide (for-label (all-from-out racket/base)))
|
||||
|
||||
(define Quick
|
||||
(other-manual '(lib "scribblings/quick/quick.scrbl")))
|
||||
(provide Quick Racket HtDP
|
||||
tool
|
||||
moreguide
|
||||
guideother
|
||||
refalso
|
||||
refdetails
|
||||
refdetails/gory
|
||||
refsecref
|
||||
ext-refsecref
|
||||
r5rs r6rs)
|
||||
|
||||
(define HtDP
|
||||
(italic (link "http://www.htdp.org" "How to Design Programs")))
|
||||
(define Quick
|
||||
(other-manual '(lib "scribblings/quick/quick.scrbl")))
|
||||
|
||||
(define (tool name . desc)
|
||||
(apply item (bold name) ", " desc))
|
||||
(define HtDP
|
||||
(italic (link "http://www.htdp.org" "How to Design Programs")))
|
||||
|
||||
(define (moreguide tag . s)
|
||||
(apply margin-note
|
||||
(decode-content (append
|
||||
(list
|
||||
finger (secref tag) " (later in this guide)"
|
||||
" explains more about ")
|
||||
s
|
||||
(list ".")))))
|
||||
(define (tool name . desc)
|
||||
(apply item (bold name) ", " desc))
|
||||
|
||||
(define (guideother . s)
|
||||
(apply margin-note
|
||||
(cons finger (decode-content s))))
|
||||
(define (moreguide tag . s)
|
||||
(apply margin-note
|
||||
(decode-content (append
|
||||
(list
|
||||
finger (secref tag) " (later in this guide)"
|
||||
" explains more about ")
|
||||
s
|
||||
(list ".")))))
|
||||
|
||||
(define (refdetails* tag what . s)
|
||||
(apply margin-note
|
||||
(decode-content (append (list magnify (ext-refsecref tag))
|
||||
(list what)
|
||||
s
|
||||
(list ".")))))
|
||||
(define (guideother . s)
|
||||
(apply margin-note
|
||||
(cons finger (decode-content s))))
|
||||
|
||||
(define (refdetails tag . s)
|
||||
(apply refdetails* tag " provides more on " s))
|
||||
(define (refdetails* tag what . s)
|
||||
(apply margin-note
|
||||
(decode-content (append (list magnify (ext-refsecref tag))
|
||||
(list what)
|
||||
s
|
||||
(list ".")))))
|
||||
|
||||
(define (refalso tag . s)
|
||||
(apply refdetails* tag " also documents " s))
|
||||
(define (refdetails tag . s)
|
||||
(apply refdetails* tag " provides more on " s))
|
||||
|
||||
(define (refdetails/gory tag . s)
|
||||
(apply refdetails* tag " documents the fine points of " s))
|
||||
(define (refalso tag . s)
|
||||
(apply refdetails* tag " also documents " s))
|
||||
|
||||
(define (refsecref s)
|
||||
(secref #:doc '(lib "scribblings/reference/reference.scrbl") s))
|
||||
(define (refdetails/gory tag . s)
|
||||
(apply refdetails* tag " documents the fine points of " s))
|
||||
|
||||
(define (ext-refsecref s)
|
||||
(make-element #f (list (refsecref s) " in " Racket)))
|
||||
(define (refsecref s)
|
||||
(secref #:doc '(lib "scribblings/reference/reference.scrbl") s))
|
||||
|
||||
(define (ext-refsecref s)
|
||||
(make-element #f (list (refsecref s) " in " Racket)))
|
||||
|
||||
(define Racket (other-manual '(lib "scribblings/reference/reference.scrbl")))
|
||||
|
||||
(define r6rs @elem{R@superscript{6}RS})
|
||||
(define r5rs @elem{R@superscript{5}RS})
|
||||
|
||||
(define Racket (other-manual '(lib "scribblings/reference/reference.scrbl"))))
|
||||
|
|
|
|||
|
|
@ -55,8 +55,6 @@ precise details to @|Racket| and other reference manuals.
|
|||
|
||||
@include-section["running.scrbl"]
|
||||
|
||||
@include-section["compile.scrbl"]
|
||||
|
||||
@include-section["other.scrbl"]
|
||||
|
||||
@include-section["dialects.scrbl"]
|
||||
|
|
|
|||
|
|
@ -1,134 +1,117 @@
|
|||
#lang scribble/manual
|
||||
@(require "guide-utils.rkt")
|
||||
|
||||
@title[#:tag "other-editors"]{Using Racket with Your Editor of Choice}
|
||||
@title[#:tag "other-editors" #:style 'toc]{Command-Line Tools and Your Editor of Choice}
|
||||
@; author["Vincent St-Amour" "Asumu Takikawa" "Jon Rafkind"]
|
||||
|
||||
Do you want to program with Racket but would rather use your editor of choice
|
||||
instead of DrRacket? Then this page is for you.
|
||||
Although DrRacket is the easiest way for most people to start with
|
||||
Racket, many Racketeers prefer command-line tools and other text
|
||||
editors. The Racket distribution includes several command-line tools,
|
||||
and popular editors include or support packages to make them work well
|
||||
with Racket.
|
||||
|
||||
Included is a brief summary of tools that will improve your Racketeering
|
||||
experience.
|
||||
|
||||
@section{Command-line Tools}
|
||||
Racket provides, as part of its standard distribution, a number of useful
|
||||
command-line tools that can make Racketeering more pleasant.
|
||||
|
||||
@subsection{Raco}
|
||||
The @exec{raco} utility provides access to Racket's build tools, package
|
||||
management utilities, documentation search and much more. For more information,
|
||||
see @other-doc['(lib "scribblings/raco/raco.scrbl")].
|
||||
|
||||
@subsection{XREPL}
|
||||
Racket ships with an eXtended REPL which provides everything you expect from a
|
||||
modern interactive environment. For instance, XREPL provides an @tt{,enter}
|
||||
command to have a REPL that runs in the context of a given module, and an
|
||||
@tt{,edit} command to invoke your @tt{$EDITOR} on the file you entered. A
|
||||
@tt{,drracket} command is also provided to make it easy to use your favorite
|
||||
editor to write code, and still have DrRacket easily available to try things
|
||||
out.
|
||||
|
||||
For more information, see @racketmodname[xrepl].
|
||||
|
||||
@subsection{Bash completion}
|
||||
Shell auto-completion for @exec{bash} is available in
|
||||
@tt{collects/meta/contrib/completion/racket-completion.bash}.
|
||||
To enable it, just run the file from your @tt{.bashrc}.
|
||||
|
||||
Note: the @tt{meta} collection is only available in the Racket Full
|
||||
distribution. The completion script is also available
|
||||
@hyperlink["https://raw.github.com/plt/racket/master/collects/meta/contrib/completion/racket-completion.bash"]{online}.
|
||||
@local-table-of-contents[]
|
||||
|
||||
@; ------------------------------------------------------------
|
||||
@include-section["cmdline.scrbl"]
|
||||
|
||||
@; ------------------------------------------------------------
|
||||
@section{Emacs}
|
||||
Emacs has long been a favorite among Lispers and Schemers, and is popular among
|
||||
Racketeers as well.
|
||||
|
||||
Emacs has long been a favorite among Lispers and Schemers, and is
|
||||
popular among Racketeers as well.
|
||||
|
||||
@subsection{Major Modes}
|
||||
|
||||
@subsubsection{Quack}
|
||||
@hyperlink["http://www.neilvandyke.org/quack/"]{Quack} is an extension of
|
||||
Emacs's @tt{scheme-mode} that provides enhanced support for Racket, including
|
||||
highlighting and indentation of Racket-specific forms, and documentation
|
||||
integration.
|
||||
@itemlist[
|
||||
|
||||
Quack is included in the Debian and Ubuntu repositories as part of the
|
||||
@tt{emacs-goodies-el} package. A Gentoo port is also available (under the name
|
||||
@tt{app-emacs/quack}).
|
||||
@item{@hyperlink["http://www.neilvandyke.org/quack/"]{Quack} is an
|
||||
extension of Emacs's @tt{scheme-mode} that provides enhanced
|
||||
support for Racket, including highlighting and indentation of
|
||||
Racket-specific forms, and documentation integration.
|
||||
|
||||
@subsubsection{Geiser}
|
||||
@hyperlink["http://www.nongnu.org/geiser/"]{Geiser} provides a programming
|
||||
environment where the editor is tightly integrated with the Racket
|
||||
REPL. Programmers accustomed to environments such as Slime or Squeak should
|
||||
feel at home using Geiser. Geiser requires GNU Emacs 23.2 or better.
|
||||
Quack is included in the Debian and Ubuntu repositories as part
|
||||
of the @tt{emacs-goodies-el} package. A Gentoo port is also
|
||||
available (under the name @tt{app-emacs/quack}).}
|
||||
|
||||
Quack and Geiser can be used together, and complement each other nicely. More
|
||||
information is available in the
|
||||
@hyperlink["http://www.nongnu.org/geiser/"]{Geiser manual}.
|
||||
@item{@hyperlink["http://www.nongnu.org/geiser/"]{Geiser} provides a
|
||||
programming environment where the editor is tightly integrated
|
||||
with the Racket REPL. Programmers accustomed to environments
|
||||
such as Slime or Squeak should feel at home using
|
||||
Geiser. Geiser requires GNU Emacs 23.2 or better.
|
||||
|
||||
Debian and Ubuntu packages for Geiser are available under the name
|
||||
@tt{geiser}.
|
||||
Quack and Geiser can be used together, and complement each
|
||||
other nicely. More information is available in the
|
||||
@hyperlink["http://www.nongnu.org/geiser/"]{Geiser manual}.
|
||||
|
||||
@subsubsection{scheme-mode}
|
||||
Emacs ships with a major mode for Scheme, @tt{scheme-mode}, that while not as
|
||||
featureful as the above options works well for editing Racket code. However,
|
||||
this mode does not provide support for Racket-specific forms.
|
||||
Debian and Ubuntu packages for Geiser are available under the
|
||||
name @tt{geiser}.}
|
||||
|
||||
@item{Emacs ships with a major mode for Scheme, @tt{scheme-mode},
|
||||
that while not as featureful as the above options, but works
|
||||
reasonably well for editing Racket code. However, this mode
|
||||
does not provide support for Racket-specific forms.}
|
||||
|
||||
@subsubsection{Scribble Mode}
|
||||
No Racket program is complete without documentation. Scribble support for emacs
|
||||
is available with Neil Van Dyke's
|
||||
@hyperlink["http://www.neilvandyke.org/scribble-emacs/"]{Scribble Mode}.
|
||||
@item{No Racket program is complete without documentation. Scribble
|
||||
support for emacs is available with Neil Van Dyke's
|
||||
@hyperlink["http://www.neilvandyke.org/scribble-emacs/"]{Scribble
|
||||
Mode}.
|
||||
|
||||
@subsubsection{Other Modes for Scribble}
|
||||
In addition to the above Scribble mode, @tt{texinfo-mode} (included with GNU
|
||||
Emacs) and plain text modes work well when editing Scribble documents. The
|
||||
Racket major modes above are not really suited to this task, given how
|
||||
different Scribble's syntax is from Racket's.
|
||||
In addition, @tt{texinfo-mode} (included with GNU Emacs) and
|
||||
plain text modes work well when editing Scribble
|
||||
documents. The Racket major modes above are not really suited
|
||||
to this task, given how different Scribble's syntax is from
|
||||
Racket's.}
|
||||
|
||||
]
|
||||
|
||||
@subsection{Minor Modes}
|
||||
|
||||
@subsubsection{Paredit}
|
||||
@hyperlink["http://mumble.net/~campbell/emacs/paredit.el"]{Paredit} is a minor
|
||||
mode for pseudo-structurally editing programs in Lisp-like languages. In
|
||||
addition to providing high-level S-expression editing commands, it prevents you
|
||||
from accidentally unbalancing parentheses.
|
||||
@itemlist[
|
||||
|
||||
Debian and Ubuntu packages for Paredit are available under the name
|
||||
@tt{paredit-el}.
|
||||
@item{@hyperlink["http://mumble.net/~campbell/emacs/paredit.el"]{Paredit}
|
||||
is a minor mode for pseudo-structurally editing programs in
|
||||
Lisp-like languages. In addition to providing high-level
|
||||
S-expression editing commands, it prevents you from
|
||||
accidentally unbalancing parentheses.
|
||||
|
||||
@subsubsection{scheme-complete}
|
||||
Alex Shinn's
|
||||
@hyperlink["http://synthcode.com/wiki/scheme-complete"]{scheme-complete}
|
||||
provides intelligent, context-sensitive code completion. It also integrates
|
||||
with Emacs's @tt{eldoc} mode to provide live documentation in the minibuffer.
|
||||
Debian and Ubuntu packages for Paredit are available under the
|
||||
name @tt{paredit-el}.}
|
||||
|
||||
While this mode was designed for R5RS Scheme, it can still be useful for Racket
|
||||
development. However, this means that the tool is unaware of large portions of
|
||||
the Racket standard library, and there may be some discrepancies in the live
|
||||
documentation in cases where Scheme and Racket have diverged.
|
||||
@item{Alex Shinn's
|
||||
@hyperlink["http://synthcode.com/wiki/scheme-complete"]{scheme-complete}
|
||||
provides intelligent, context-sensitive code completion. It
|
||||
also integrates with Emacs's @tt{eldoc} mode to provide live
|
||||
documentation in the minibuffer.
|
||||
|
||||
@subsubsection{Rainbow Delimiters}
|
||||
The @hyperlink["http://www.emacswiki.org/emacs/RainbowDelimiters"]{rainbow
|
||||
delimiters} mode colors parentheses and other delimiters according to their
|
||||
nesting depth. It makes it easier to know, at a glance, which parentheses
|
||||
match.
|
||||
While this mode was designed for @seclink["r5rs"]{@|r5rs|}, it
|
||||
can still be useful for Racket development. That the tool is
|
||||
unaware of large portions of the Racket standard library, and
|
||||
there may be some discrepancies in the live documentation in
|
||||
cases where Scheme and Racket have diverged.}
|
||||
|
||||
@subsubsection{ParenFace}
|
||||
@hyperlink["http://www.emacswiki.org/emacs/ParenFace"]{ParenFace} lets you
|
||||
choose in which face (font, color, etc.) parentheses should be displayed. This
|
||||
makes it possible to make "tone down" parentheses.
|
||||
@item{The
|
||||
@hyperlink["http://www.emacswiki.org/emacs/RainbowDelimiters"]{RainbowDelimiters}
|
||||
mode colors parentheses and other delimiters according to their
|
||||
nesting depth. Coloring by nesting depth makes it easier to
|
||||
know, at a glance, which parentheses match.}
|
||||
|
||||
@item{@hyperlink["http://www.emacswiki.org/emacs/ParenFace"]{ParenFace}
|
||||
lets you choose in which face (font, color, etc.) parentheses
|
||||
should be displayed. Choosing an alternate face makes it
|
||||
possible to make ``tone down'' parentheses.}
|
||||
|
||||
]
|
||||
|
||||
@; ------------------------------------------------------------
|
||||
|
||||
@section{Vim}
|
||||
|
||||
@subsection{Settings}
|
||||
Many distributions of Vim ship with support for Scheme, which will
|
||||
mostly work for Racket. You can enable filetype detection of Racket
|
||||
files as Scheme with the following:
|
||||
|
||||
Many distributions of vim ship with support for Scheme, which will mostly work
|
||||
for Racket. You can enable filetype detection of Racket files as Scheme with the
|
||||
following:
|
||||
|
||||
@verbatim|{
|
||||
@verbatim[#:indent 2]|{
|
||||
if has("autocmd")
|
||||
au BufReadPost *.rkt,*.rktl set filetype=scheme
|
||||
endif
|
||||
|
|
@ -139,9 +122,9 @@ Alternatively, you can use the
|
|||
plugin to enable auto-detection, indentation, and syntax highlighting
|
||||
specifically for Racket files. Using the plugin is the easiest method, but if you
|
||||
would like to roll your own settings or override settings from the plugin, add
|
||||
something like the following to your vimrc:
|
||||
something like the following to your @filepath{.vimrc} file:
|
||||
|
||||
@verbatim|{
|
||||
@verbatim[#:indent 2]|{
|
||||
if has("autocmd")
|
||||
au BufReadPost *.rkt,*.rktl set filetype=racket
|
||||
au filetype racket set lisp
|
||||
|
|
@ -151,14 +134,14 @@ endif
|
|||
|
||||
However, if you take this path you may need to do more work when installing
|
||||
plugins because many Lisp-related plugins and scripts for vim are not aware of
|
||||
Racket. You can also set these conditional commands in a @tt{scheme.vim} or
|
||||
@tt{racket.vim} file in the @tt{ftplugin} subdirectory of your vim folder.
|
||||
Racket. You can also set these conditional commands in a @filepath{scheme.vim} or
|
||||
@filepath{racket.vim} file in the @filepath{ftplugin} subdirectory of your vim folder.
|
||||
|
||||
Most installations of vim will automatically have useful defaults enabled,
|
||||
but if your installation does not, you will want to set at least the following
|
||||
in your .vimrc file:
|
||||
in your @filepath{.vimrc} file:
|
||||
|
||||
@verbatim|{
|
||||
@verbatim[#:indent 2]|{
|
||||
" Syntax highlighting
|
||||
syntax on
|
||||
|
||||
|
|
@ -174,7 +157,7 @@ set expandtab
|
|||
@subsection{Indentation}
|
||||
|
||||
You can enable indentation for Racket by setting both the @tt{lisp} and
|
||||
@tt{autoindent} options. However, the indentation is limited and not as
|
||||
@tt{autoindent} options in Vim. However, the indentation is limited and not as
|
||||
complete as what you can get in Emacs. You can also use Dorai Sitaram's
|
||||
@hyperlink["http://evalwhen.com/scmindent/index.html"]{scmindent} for
|
||||
better indentation of Racket code. The instructions on how to
|
||||
|
|
@ -183,9 +166,9 @@ use the indenter are available on the website.
|
|||
If you use the built-in indenter, you can customize it by setting how to
|
||||
indent certain keywords. The vim-racket plugin mentioned above sets
|
||||
some default keywords for you. You can add keywords yourself in your
|
||||
.vimrc like this:
|
||||
@filepath{.vimrc} file like this:
|
||||
|
||||
@verbatim|{
|
||||
@verbatim[#:indent 2]|{
|
||||
" By default vim will indent arguments after the function name
|
||||
" but sometimes you want to only indent by 2 spaces similar to
|
||||
" how DrRacket indents define. Set the `lispwords' variable to
|
||||
|
|
@ -200,15 +183,15 @@ set lispwords+=..more..
|
|||
The @hyperlink["http://www.vim.org/scripts/script.php?script_id=1230"]{Rainbow
|
||||
Parenthesis} script for vim can be useful for more visible parenthesis
|
||||
matching. Syntax highlighting for Scheme is shipped with vim on many platforms,
|
||||
which will work for the most part with Racket. The vim-racket script will
|
||||
provide good default highlighting settings for you.
|
||||
which will work for the most part with Racket. The vim-racket script
|
||||
provides good default highlighting settings for you.
|
||||
|
||||
@subsection{Structured editing}
|
||||
@subsection{Structured Editing}
|
||||
|
||||
The @hyperlink["http://www.vim.org/scripts/script.php?script_id=2531"]{Slimv}
|
||||
plugin has a paredit mode that works like paredit in Emacs. However, the plugin
|
||||
is not aware of Racket. You can either set vim to treat Racket as Scheme files
|
||||
or you can modify the paredit script to load on @tt{*.rkt} files.
|
||||
or you can modify the paredit script to load on @filepath{.rkt} files.
|
||||
|
||||
@subsection{Miscellaneous}
|
||||
|
||||
|
|
@ -216,4 +199,4 @@ If you are installing many vim plugins (not necessary specific to Racket), we
|
|||
recommend using a plugin that will make loading other plugins easier.
|
||||
@hyperlink["http://www.vim.org/scripts/script.php?script_id=2332"]{Pathogen} is
|
||||
one plugin that does this; using it, you can install new plugins by extracting
|
||||
them to subdirectories in the @tt{bundle} folder of your vim directory.
|
||||
them to subdirectories in the @filepath{bundle} folder of your Vim installation.
|
||||
|
|
|
|||
|
|
@ -38,11 +38,11 @@ Racket's main tools are
|
|||
|
||||
]
|
||||
|
||||
Most likely, you'll want to explore the Racket language using DrRacket,
|
||||
especially at the beginning. If you prefer, you can also work with the
|
||||
command-line @exec{racket} interpreter and your favorite text
|
||||
editor. The rest of this guide presents the language mostly
|
||||
independent of your choice of editor.
|
||||
Most likely, you'll want to explore the Racket language using
|
||||
DrRacket, especially at the beginning. If you prefer, you can also
|
||||
work with the command-line @exec{racket} interpreter and your favorite
|
||||
text editor; see also @secref["other-editors"]. The rest of this guide
|
||||
presents the language mostly independent of your choice of editor.
|
||||
|
||||
If you're using DrRacket, you'll need to choose the proper language,
|
||||
because DrRacket accommodates many different variants of Racket, as
|
||||
|
|
@ -228,14 +228,6 @@ hoc command-line flags, compiler directives, and build tools. The
|
|||
module system is designed to avoid these problems, so start with
|
||||
@hash-lang[], and you'll be happier with Racket in the long run.
|
||||
|
||||
@; ----------------------------------------------------------------------
|
||||
@section{A Note about Editors}
|
||||
|
||||
Racket ships with the DrRacket programming environment. If you are already
|
||||
familiar with another editor, it is certainly possible to use it for Racket
|
||||
development. To improve your racketeering experience with your editor of
|
||||
choice, see @secref["other-editors"].
|
||||
|
||||
@; ----------------------------------------------------------------------
|
||||
|
||||
@close-eval[piece-eval]
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@
|
|||
scribble/eval
|
||||
(only-in scribble/core link-element)
|
||||
"../quick/keep.rkt"
|
||||
(only-in xrepl/doc-utils [cmd xreplcmd])
|
||||
(for-label scheme
|
||||
racket/enter
|
||||
xrepl
|
||||
|
|
@ -46,12 +47,6 @@
|
|||
|
||||
(define-syntax-rule (REQ m) @racket[(require @#,racketmodname[m])])
|
||||
|
||||
(define (xreplcmd name . args)
|
||||
(define namestr (format ",~a" name))
|
||||
(define content
|
||||
(litchar (if (null? args) namestr (apply string-append namestr " " args))))
|
||||
(link-element "plainlink" content `(xrepl ,(format "~a" name))))
|
||||
|
||||
)
|
||||
|
||||
@title{More: Systems Programming with Racket}
|
||||
|
|
@ -94,33 +89,33 @@ start @exec{racket} with no command-line arguments:
|
|||
>
|
||||
}
|
||||
|
||||
To get a richer read-eval-print-loop, evaluate @REQ[xrepl]. You will
|
||||
get Readline-based input if you have GNU Readline installed on your
|
||||
system, and a useful set of meta-commands to support exploration and
|
||||
development.
|
||||
For extra read-eval-print loop support, evaluate @REQ[xrepl]
|
||||
to enable Readline-based input---assuming that you have GNU Readline
|
||||
installed on your system---and comma-prefixed meta-commands that
|
||||
support exploration and development. To have @racketmodname[xrepl]
|
||||
loaded by default, use the @xreplcmd{install!} command, which updates
|
||||
your @filepath{~/.racketrc} to load @racketmodname[xrepl] whenever you
|
||||
start @exec{racket} for interactive evaluation.
|
||||
|
||||
@margin-note{Unfortunately, for legal reasons related to GPL vs. LGPL,
|
||||
@exec{racket} cannot provide Readline automatically.}
|
||||
|
||||
@interaction[
|
||||
(eval:alts @#,REQ[xrepl] (void))
|
||||
(eval:alts @#,xreplcmd{install!} (void))
|
||||
]
|
||||
|
||||
To get this as a default, use the @xreplcmd{install!} command---your
|
||||
@filepath{~/.racketrc} will be updated to load @racketmodname[xrepl]
|
||||
whenever you start @exec{racket} for interactive evaluation.
|
||||
|
||||
@margin-note{Unfortunately, for legal reasons related to GPL vs. LGPL,
|
||||
@exec{racket} cannot provide @racketmodname[xrepl] or Readline
|
||||
automatically.}
|
||||
|
||||
@; FIXME: probably needs revisions, and questionable whether readline
|
||||
@; should be mentioned by itself. One thing to consider is that with
|
||||
@; readline it's possible to pretend that the whole thing is one
|
||||
@; session, whereas xrepl changes the prompt.
|
||||
|
||||
If you want @emph{just} readline support in @exec{racket}, evaluate
|
||||
@REQ[readline]. To install this in your @filepath{~/.racketrc},
|
||||
evaluate @racket[(install-readline!)]. Readline is not needed if you're
|
||||
using @racketmodname[xrepl], if you're running a shell inside Emacs, or
|
||||
if you're on Windows and use a @exec{cmd} window.
|
||||
@REQ[readline], instead, and then use @racket[(install-readline!)] to
|
||||
adjust @filepath{~/.racketrc} to load @racketmodname[readline].
|
||||
Readline is not needed if you're using @racketmodname[xrepl], if
|
||||
you're running a shell inside Emacs, or if you're on Windows and use a
|
||||
@exec{cmd} window.
|
||||
|
||||
@interaction[
|
||||
(eval:alts @#,REQ[readline] (void))
|
||||
|
|
|
|||
|
|
@ -131,14 +131,18 @@ show the author(s) of a document, where each author is represented by
|
|||
@racket[title] for the beginning of a document. See also
|
||||
@racket[author+email].}
|
||||
|
||||
@defproc[(author+email [author elem]
|
||||
@defproc[(author+email [author-name elem]
|
||||
[email string?]
|
||||
[#:obfuscate? obfuscate? any/c #f])
|
||||
element?]{
|
||||
|
||||
Combines an author name with an e-mail address. If @racket[obfuscate?]
|
||||
is true, then the result obscures the e-mail address slightly to avoid
|
||||
address-harvesting robots.}
|
||||
address-harvesting robots.
|
||||
|
||||
Note that @racket[author+email] is not a replacement for
|
||||
@racket[author]. The @racket[author+email] function is often used in
|
||||
combination with @racket[author].}
|
||||
|
||||
@; ------------------------------------------------------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,18 @@
|
|||
#lang scribble/doc
|
||||
@(require scribble/manual "doc-utils.rkt"
|
||||
#lang scribble/manual
|
||||
@(require "doc-utils.rkt"
|
||||
scribble/decode (only-in scribble/core)
|
||||
(for-label racket readline racket/help racket/enter
|
||||
racket/trace profile))
|
||||
|
||||
@title{XREPL: eXtended REPL}
|
||||
@author+email["Eli Barzilay" "eli@barzilay.org"]
|
||||
@author[@author+email["Eli Barzilay" "eli@barzilay.org"]]
|
||||
|
||||
@defmodule[xrepl]{
|
||||
The @filepath{xrepl} collection extends the @exec{racket} @tech[#:doc
|
||||
Loading the @racketmodname[xrepl] library enables XREPL,
|
||||
which extends the @exec{racket} @tech[#:doc
|
||||
GUIDE]{REPL} significantly, turning it into a more useful tool for
|
||||
interactive exploration and development. This includes ``meta
|
||||
commands'', using readline, keeping past evaluation results, and
|
||||
interactive exploration and development. Additions include ``meta
|
||||
commands,'' using readline, keeping past evaluation results, and
|
||||
more.}
|
||||
|
||||
@; ---------------------------------------------------------------------
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user