move setup/infotab documentation to setup-plt manual
svn: r8539
This commit is contained in:
parent
794e6c8a39
commit
52355ec9e6
|
@ -66,7 +66,7 @@ The @filepath{.zo} files are placed into the collection's
|
|||
@filepath{compiled} directory.
|
||||
|
||||
The collection compiler reads the collection's @filepath{info.ss} file
|
||||
(see @secref[#:doc '(lib "scribblings/reference/reference.scrbl")
|
||||
(see @secref[#:doc '(lib "scribblings/setup-plt/setup-plt.scrbl")
|
||||
"info.ss"]) to obtain information about compiling the collection. The
|
||||
following fields are used:
|
||||
|
||||
|
|
|
@ -7,6 +7,5 @@
|
|||
|
||||
@include-section["startup.scrbl"]
|
||||
@include-section["collects.scrbl"]
|
||||
@include-section["info.scrbl"]
|
||||
@include-section["help.scrbl"]
|
||||
@include-section["enter.scrbl"]
|
||||
|
|
|
@ -1,14 +1,17 @@
|
|||
#lang scribble/doc
|
||||
@(require "mz.ss"
|
||||
(for-label string-constants/string-constant
|
||||
@(require scribble/manual
|
||||
(for-label scheme
|
||||
string-constants/string-constant
|
||||
setup/getinfo))
|
||||
|
||||
@title[#:tag "info.ss"]{@filepath{info.ss} File Format}
|
||||
|
||||
In each @tech{collection}, a special module file @filepath{info.ss}
|
||||
provides general information about a collection for use by various
|
||||
tools. For example, an @filepath{info.ss} file specifies how to build
|
||||
the documentation for a collection, and it lists plug-in tools for
|
||||
@defmodulelang[setup/infotab]
|
||||
|
||||
In each collection, a special module file @filepath{info.ss} provides
|
||||
general information about a collection for use by various tools. For
|
||||
example, an @filepath{info.ss} file specifies how to build the
|
||||
documentation for a collection, and it lists plug-in tools for
|
||||
DrScheme that the collection provides.
|
||||
|
||||
Although an @filepath{info.ss} file contains a module declaration, the
|
||||
|
@ -45,7 +48,7 @@ grammar of @scheme[_info-module]:
|
|||
For example, the following declaration could be the @filepath{info.ss}
|
||||
library of the @filepath{help} collection. It contains definitions for
|
||||
three info tags, @scheme[name], @scheme[mzscheme-launcher-libraries], and
|
||||
@scheme[mzscheme-launcher-names]. (Note the use of @litchar{#lang}.)
|
||||
@scheme[mzscheme-launcher-names].
|
||||
|
||||
@schememod[
|
||||
setup/infotab
|
||||
|
@ -54,9 +57,14 @@ setup/infotab
|
|||
(define mzscheme-launcher-names '("PLT Help"))
|
||||
]
|
||||
|
||||
As illustrated in this example, an @filepath{info.ss} file can use
|
||||
@hash-lang[] notation, but only with the @schememodname[setup/infotab]
|
||||
language.
|
||||
|
||||
The @scheme[name] tag is required for @exec{setup-plt} to recognize
|
||||
the collection and compile its files to bytecode. Similarly, an
|
||||
@filepath{info.ss} file in a sub-directory of a collection causes the
|
||||
sub-directory's files to be compiled.
|
||||
|
||||
See also @scheme[get-info] from @schememodname[setup/getinfo].
|
||||
|
|
@ -106,10 +106,7 @@ collection that:
|
|||
|
||||
@itemize{
|
||||
|
||||
@item{has an @filepath{info.ss} library (see the
|
||||
@italic{@other-manual['(lib "scribblings/mzc/mzc.scrbl")]} manual,
|
||||
or @secref[#:doc ref-src "info.ss"] in Reference for a
|
||||
description);}
|
||||
@item{has an @filepath{info.ss} library (see @secref["info.ss"]);}
|
||||
|
||||
@item{has a @scheme[name] field in @filepath{info.ss}; and}
|
||||
|
||||
|
@ -901,14 +898,11 @@ An @deftech{unpackable} is one of the following:
|
|||
|
||||
@; ------------------------------------------------------------------------
|
||||
|
||||
@section[#:tag "getinfo"]{Reading @filepath{info.ss} Files}
|
||||
@include-section["info.scrbl"]
|
||||
|
||||
@defmodulelang[setup/infotab]{@filepath{info.ss} use the
|
||||
@schememodname[setup/infotab] language, which allows simple
|
||||
definitions and a few constructors (like @scheme[list] and
|
||||
@scheme[build-path]). Furthermore, the functions that are described
|
||||
below require an @filepath{info.ss} to be in a specific shape, so you
|
||||
cannot use a different module for these files.}
|
||||
@; ------------------------------------------------------------------------
|
||||
|
||||
@section[#:tag "getinfo"]{Reading @filepath{info.ss} Files}
|
||||
|
||||
@defmodule[setup/getinfo]{ The @schememodname[setup/getinfo] library
|
||||
provides functions for accessing fields in @filepath{info.ss}
|
||||
|
@ -930,7 +924,7 @@ cannot use a different module for these files.}
|
|||
Accepts a path to a directory. It returns @scheme[#f] if there is
|
||||
no @filepath{info.ss} file in the directory. If the
|
||||
@filepath{info.ss} file has the wrong shape (i.e., not a module
|
||||
using @scheme[setup/infotab] or @scheme[(lib "infotab.ss" "setup")]),
|
||||
using @schememodname[setup/infotab] or @scheme[(lib "infotab.ss" "setup")]),
|
||||
or if the @filepath{info.ss} file fails to load, then an exception
|
||||
is raised.
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user