Skip to content

Commit 3b596db

Browse files
committed
SUG: small addition (fix Stellarium#1275)
1 parent 8db10e4 commit 3b596db

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

guide/ch_advanced_use.tex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,13 @@ \section{Directory Structure}
142142
\item[\file{skycultures/}] contains constellations, common star names and
143143
constellation artwork for Stellarium's many sky cultures. Each culture
144144
has its own sub-directory in the skycultures directory.
145+
\item[\file{scripts/}] contains your own scripts. These can be used to create
146+
complex demonstrations (see ch.~\ref{ch:scripting}).
145147
\item[\file{nebulae/}] contains data and image files for nebula textures.
146148
In the future Stellarium may be able to support multiple sets of nebula
147149
images and switch between them at runtime. This feature is not
148150
implemented for version~\StelVersion, although the directory structure is in
149-
place - each set of nebula textures has its own sub-directory in the
151+
place -- each set of nebula textures has its own sub-directory in the
150152
nebulae directory.
151153
%% TODO: Update this if no longer valid.
152154
\item[\file{stars/}] contains Stellarium's star catalogues. In the

guide/ch_scripting.tex

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -151,13 +151,16 @@ \section{Example: Retrograde motion of Mars}
151151
\end{figure}
152152

153153
\subsection{Script header}
154-
Any ``complex'' script should contain a few lines in the first part
155-
of the file, which contains important data for humans --- the
156-
name of the script and its description --- and some rules for
157-
Stellarium. You can even assign default shortcuts in the script header,
158-
but make sure you assign a key not used elsewhere! The description
159-
may cover several lines (until the end of the commented header)
160-
and should therefore be the last entry of the header.
154+
Any ``complex'' script should contain a few lines in the first part of
155+
the file, which contains important data for humans --- the name of the
156+
script and its description --- and some rules for Stellarium. You can
157+
even assign default shortcuts in the script header, but make sure you
158+
assign a key not used elsewhere! The shortcuts are read during startup
159+
from all scripts in the \file{scripts} subdirectories of both program
160+
and user data directories (see section
161+
\ref{sec:FilesAndDirectories:DirectoryStructure}). The description
162+
may cover several lines (until the end of the commented header) and
163+
should therefore be the last entry of the header.
161164

162165
\begin{script}
163166
//

0 commit comments

Comments
 (0)