mirror of
https://github.com/ganelson/inform.git
synced 2024-06-17 07:40:47 +03:00
Merge pull request #21 from andrewschultz/inb-d-typos
typos found in INB*/IND* directories
This commit is contained in:
commit
10409f1f07
|
@ -84,7 +84,7 @@ can be set -- including none at all, but if so then commands needing a
|
|||
named template, like |website|, can't be used. Inblorb looks for any
|
||||
template it needs by trying each template path in turn (the earliest
|
||||
defined having the highest priority). The blurb files produced by |inform7|
|
||||
in its |-release| mode containa chain of three template paths, for the
|
||||
in its |-release| mode contain a chain of three template paths, for the
|
||||
individual project folder, the user's library of installed templates, and
|
||||
the built-in stock inside the Inform user interface application,
|
||||
respectively.
|
||||
|
|
|
@ -184,13 +184,13 @@ will do: they mean that this is (the best) version Inbuild has access to.
|
|||
They're given because two different versions of the same extension might
|
||||
make different choices about which other extensions to include. We can say
|
||||
that version 3 of Menus wants to have Basic Screen Effects, but maybe someday
|
||||
tbere will be a version 4 which doesn't need it.
|
||||
there will be a version 4 which doesn't need it.
|
||||
|
||||
Another issue to watch out for is that a copy may use different other copies
|
||||
when compiled to different virtual machines. For example, an extension can
|
||||
contain a heading of material "for Glulx only", and that heading might
|
||||
comtain a line which includes another extension X. If so, then we use X on
|
||||
Glulx but not on other architectures. We can also flag materual as being for
|
||||
Glulx but not on other architectures. We can also flag material as being for
|
||||
release only, or for debugging only.
|
||||
|
||||
Inbuild accepts the same command-line options as |inform7| does to specify
|
||||
|
@ -230,14 +230,14 @@ but also how to perform that build.
|
|||
|
||||
As noted above, not everything needs building. Extensions do not, in particular,
|
||||
so running |-build| on one will do nothing. Kits do need building: what this
|
||||
does is to "assimilate" the Unform 6-notation source files inside the kit into
|
||||
does is to "assimilate" the Inform 6-notation source files inside the kit into
|
||||
binary files of Inter, one for each possible architecture.
|
||||
|
||||
But building is mostly done with projects. If we run:
|
||||
= (text as ConsoleText)
|
||||
$ inbuild/Tangled/inbuild -build Example.inform
|
||||
=
|
||||
then Inbuild will first build everthing needed to build the Example story
|
||||
then Inbuild will first build everything needed to build the Example story
|
||||
file, including everything needed to use the things needed to build it, and
|
||||
so on; and then will build Example itself. As with the Unix utility |make|,
|
||||
this is an incremental process, and looks at the timestamps of files to see
|
||||
|
@ -275,7 +275,7 @@ specify path |P| as the home of the other Intools.
|
|||
|
||||
@h Specifying what to act on.
|
||||
In all of the examples above, Inbuild is given just one copy to act on.
|
||||
(That action may end up invplving lots of other copies, but only one is
|
||||
(That action may end up involving lots of other copies, but only one is
|
||||
mentioned on the command line.) In fact it's legal to give a list of
|
||||
copies to work on, one at a time, except that only one of those copies
|
||||
can be an Inform project. Multiple extensions, or kits, are fine.
|
||||
|
@ -341,7 +341,7 @@ Other subdirectories can also exist, and Inbuild ignores those. The above
|
|||
five containers hold website templates (used by Inblorb), Inter pipelines,
|
||||
kits, language definitions, and extensions. In the case of extensions, where
|
||||
there may be very many in total, a further level of subdirectory is used
|
||||
for the authpr's name. Thus:
|
||||
for the author's name. Thus:
|
||||
= (text)
|
||||
Extensions/Emily Short/Locksmith.i7x
|
||||
=
|
||||
|
|
|
@ -8,7 +8,7 @@ The //supervisor// module provides services to the parent tool.
|
|||
This section defines how the parent communicates with us to get everything
|
||||
set up correctly. Although nothing at all clever happens in this code, it
|
||||
requires careful sequencing to avoid invisible errors coming in because
|
||||
function X assumes that function Y has already been called, or perhaos that
|
||||
function X assumes that function Y has already been called, or perhaps that
|
||||
it never will be again. The //supervisor// module therefore runs through a
|
||||
number of named "phases" on its way to reaching fully-operational status,
|
||||
at which time the parent can freely use its facilities.
|
||||
|
@ -366,7 +366,7 @@ But among nests three are special, and can hold other things as well.
|
|||
|
||||
(a) The "internal" nest is part of the installation of Inform as software.
|
||||
It contains, for example, the build-in extensions. But it also contains
|
||||
miscellaneous other files needed by Infomr (see below).
|
||||
miscellaneous other files needed by Inform (see below).
|
||||
|
||||
(b) The "external" nest is the one to which the user installs her own
|
||||
selection of extensions, and so on. On most platforms, the external nest
|
||||
|
|
|
@ -211,7 +211,7 @@ void CopyErrors::write(OUTPUT_STREAM, copy_error *CE) {
|
|||
case HeadingInPlaceOfUnincluded_SYNERROR:
|
||||
WRITE("heading is in place of an extension not included"); break;
|
||||
case UnequalHeadingInPlaceOf_SYNERROR:
|
||||
WRITE("heading is in place of another heading but of a diffeent level"); break;
|
||||
WRITE("heading is in place of another heading but of a different level"); break;
|
||||
case HeadingInPlaceOfSubordinate_SYNERROR:
|
||||
WRITE("heading is in place of another heading subordinate to itself"); break;
|
||||
case HeadingInPlaceOfUnknown_SYNERROR:
|
||||
|
|
|
@ -25,8 +25,8 @@ inbuild_nest *Nests::new(pathname *P) {
|
|||
}
|
||||
|
||||
@ Nests used by the Inform and Inbuild tools are tagged with the following
|
||||
comstamts. (There used to be quite a good joke here, but refactoring of the
|
||||
code removed its premiss. Literate programming is like that sometimes.)
|
||||
constants. (There used to be quite a good joke here, but refactoring of the
|
||||
code removed its premise. Literate programming is like that sometimes.)
|
||||
|
||||
The sequence of the following enumerated values is very significant --
|
||||
see below for why. Lower-tag-numbered origins are better than later ones.
|
||||
|
|
|
@ -4,7 +4,7 @@ To store, hash code and compare title/author pairs used to identify works.
|
|||
|
||||
@h Works.
|
||||
A "work" is a single artistic or programming creation; for example, the IF
|
||||
story Bronze by Emily Short might be a work. Mamy versions of this IF story
|
||||
story Bronze by Emily Short might be a work. Many versions of this IF story
|
||||
may exist over time, but they will all be versions of the same "work".
|
||||
Extensions are also works: for example, Epistemology by Eric Eve is a work.
|
||||
|
||||
|
@ -129,7 +129,7 @@ void Works::write_link_to_HTML_file(OUTPUT_STREAM, inbuild_work *work) {
|
|||
}
|
||||
|
||||
@ The Inbuild module provides the |%X| escape sequence for printing names of
|
||||
works. (The X used to stand for Extension.) |%<X| ptovides an abbreviated form.
|
||||
works. (The X used to stand for Extension.) |%<X| provides an abbreviated form.
|
||||
|
||||
=
|
||||
void Works::writer(OUTPUT_STREAM, char *format_string, void *vE) {
|
||||
|
|
|
@ -221,7 +221,7 @@ building V is itself a use of W, and therefore of X. So we always enable the
|
|||
it would be redundant to recreate it.
|
||||
|
||||
Note that equal timestamps force rebuilding. File timestamping is quite coarse
|
||||
on some systems, so equal timeatamps might only mean that the two files were
|
||||
on some systems, so equal timestamps might only mean that the two files were
|
||||
created during the same second.
|
||||
|
||||
@<Decide based on timestamps@> =
|
||||
|
|
|
@ -121,7 +121,7 @@ searching through the nests. //supervisor// does this by creating an
|
|||
search engine //Nests::search_for//. This builds a list of //inbuild_search_result//
|
||||
objects, each pointing to a new copy which matches the requirement given.
|
||||
|
||||
Requirements can be quite flexible, and are converitble to and from text: see
|
||||
Requirements can be quite flexible, and are convertible to and from text: see
|
||||
//Requirements::from_text// and //Requirements::write//.[2] The crucial function
|
||||
here is //Requirements::meets//, which tests whether an edition meets the
|
||||
requirement.
|
||||
|
|
|
@ -18,7 +18,7 @@ void Updater::add_reference_symbol(text_stream *symbol_name, volume *V, section
|
|||
}
|
||||
|
||||
@h Cross-references file.
|
||||
Until January 2020, Inform managed cross-references to its dcumentation in a
|
||||
Until January 2020, Inform managed cross-references to its documentation in a
|
||||
clumsy way, with explicit sentences such as:
|
||||
= (text as Indoc)
|
||||
Document kind_person at doc45 "3.17" "Men, women and animals".
|
||||
|
|
|
@ -260,7 +260,7 @@ is cosmetic, and provides extra styling on lines of documentation giving the
|
|||
syntax for Inform phrases.
|
||||
|
||||
|javascript| can be |yes| or |no|. The default is |yes|. This indicates
|
||||
whetber Indoc is allowed to compile Javascript, or has to stick to inactive
|
||||
whether Indoc is allowed to compile Javascript, or has to stick to inactive
|
||||
HTML.
|
||||
|
||||
|link_to_extensions_index| is meaningful only if |html_for_Inform_application|
|
||||
|
|
Loading…
Reference in a new issue