Source Browser ?

1% language=us runpath=texruns:manuals/readme
2
3% author    : Hans Hagen
4% copyright : ConTeXt Development Team
5% license   : Creative Commons Attribution ShareAlike 4.0 International
6% reference : pragma-ade.nl | contextgarden.net | texlive (related) distributions
7% origin    : the ConTeXt distribution
8%
9% comment   : Because this manual is distributed with TeX distributions it comes with a rather
10%             liberal license. We try to adapt these documents to upgrades in the (sub)systems
11%             that they describe. Using parts of the content otherwise can therefore conflict
12%             with existing functionality and we cannot be held responsible for that. Many of
13%             the manuals contain characteristic graphics and personal notes or examples that
14%             make no sense when used out-of-context.
15%
16% comment   : Some chapters might have been published in TugBoat, the NTG Maps, the ConTeXt
17%             Group journal or otherwise. Thanks to the editors for corrections. Also thanks
18%             to users for testing, feedback and corrections.
19
20\environment mcommon
21
22% copied from cont-log: readme_logo
23
24\startuseMPgraphic{titlepage}{width,height}
25    numeric width ; width = \MPvar{width} ;
26    numeric height ; height = \MPvar{height} ;
27    numeric delta ; delta := width/10 ;
28    numeric circle ; circle := 2.5delta ;
29    color c ; c := (.2,.4,.6) ;
30    path p, q, r ;
31    p := unitsquare xscaled width yscaled height ;
32    z1 = (delta,height-2delta) ;
33    z2 = (width-delta,height-delta) ;
34    z3 = (width/2-delta,2delta+circle) ;
35    z4 = (x3,delta+circle/2) ;
36    q := z1 { dir  -15 } .. z2 & z2 { dir -105 } .. z3 & z3 { dir  135 } .. z1 & cycle ;
37    r := fullcircle xscaled circle yscaled (.85circle) rotated 15 shifted z4 ;
38    pickup pencircle scaled (delta/1.5) ;
39    fill p withcolor .50c ;
40    fill q withcolor .75c ;
41    fill r withcolor .75c ;
42    draw p withcolor    c ;
43    draw q withcolor    c ;
44    pickup pencircle scaled (delta/2) ;
45    draw r withcolor    c ;
46    setbounds currentpicture to p ;
47\stopuseMPgraphic
48
49\startdocument
50  [title={Read Me First},
51   author={Hans Hagen},
52   affiliation={PRAGMA ADE},
53   location={Hasselt NL}]
54
55\startsubject[title={Introduction}]
56
57What license suits best for a \TEX\ like system is a matter of taste. Personally
58we dislike any license that needs more than a few pages of dense legal code to
59get the message across. A \TEX\ related system like \CONTEXT\ is a hybrid of
60programs, scripts and|/|or macro code as well as documentation and sample code,
61including graphics. \TEX\ related systems also have a long standing tradition of
62providing support structures for users. In order to make support feasible, a
63\TEX\ based system like \CONTEXT\ assumes a certain logic and structure in the
64way the related files are named and organized in a tree structure. Even a small
65change in one of the elements may let such a system behave differently than
66manuals suggest. Swap a font, change some style defaults, leave out some pieces,
67and users may end up in confusion. A license does not give a user any guarantees!
68
69In order to satisfy those responsible for distributing \CONTEXT, we need to
70choose a license that makes them feel comfortable. Unfortunately we don't feel
71that comfortable with a license that does not provide the guarantees that a
72system will not be adapted in such ways that the advertised behavior changes. On
73the other hand, it is the responsibility of those distributing and extending the
74system to make sure that this does not happen. However, users should not
75automatically assume that what they get shipped is the same as the original,
76which is why we stress that support (from our side) will only be given on
77unaltered systems.
78
79First of all, what is \CONTEXT ? It's just a bunch of macros, written in \TEX\
80and \METAPOST, meant for typesetting documents. The macros are accompanied by
81some scripts, written in \PERL\ (mainly the older scripts) \RUBY\ (also older
82ones) and \LUA\ (the current fashion). The \CONTEXT\ distribution comes with a
83few fonts, files that help manage resources (e.g.\ map files needed for \MKII),
84as well as patterns (based on official ones, so this is a derived work).
85
86The \CONTEXT\ distribution is packaged in a zip file organized in the \TDS\
87structure.
88
89\starttabulate[|lT|p|]
90\NC \type {cont-tmf.zip} \NC the main distribution that has all relevant files \NC \NR
91\NC \type {cont-tst.7z}  \NC a bunch of test files that can also serve as examples \NC \NR
92\NC \type {cont-mpd.zip} \NC a \METAPOST\ to \PDF\ converter (not needed in \CONTEXT) \NC \NR
93\NC \type {cont-ppc.zip} \NC a macro package for typesetting chemistry (not needed in \CONTEXT) \NC \NR
94\NC \type {cont-sci.zip} \NC configuration files for using \CONTEXT\ in the \SCITE\ editor \NC \NR
95\stoptabulate
96
97There are two flavours of \CONTEXT: \MKII\ and \MKIV. The first one is frozen and
98will not be extended. It runs on top of \PDFTEX\ or \XETEX. The \MKIV\ version is
99actively developed and runs on top of \LUATEX\ (an engine that is developed
100alongside \CONTEXT\ but that can also be used for other macro packages).
101
102The documentation can be downloaded from our website or the Wiki. Some manuals
103ship with source code. We might ship more source code but only when the source is
104stable and clean and can serve as an example.
105
106That said, what license does apply? We need to distinguish between things that
107resemble a program on the one hand and documentation on the other hand. We
108(currently) use a different license for either of them.
109
110\stopsubject
111
112\startsubject[title={The Code}]
113
114The program code (i.e. anything not under the \type {/doc} subtree) is
115distributed under the
116
117\startnarrower
118\goto{Creative Commons GNU GPL}[url(gpl-simple)]
119\stopnarrower
120
121For practical purposes distributors may also choose the \LATEX\ project license,
122which is considered to be a bit more \TEX\ friendly. (BSD alike licenses also
123apply well for \CONTEXT.)
124
125In practice, users may forget about the legal part, if only because I haven't
126even read (and understood) it completely myself, so let's stick to what Creative
127Commons makes of it:
128
129\startcolor[blue]
130The GNU General Public License is a Free Software license. Like any Free Software
131license, it grants to you the four following freedoms:
132
133\startitemize
134    \startitem
135        The freedom to run the program for any purpose.
136    \stopitem
137    \startitem
138        The freedom to study how the program works and adapt it to your needs.
139    \stopitem
140    \startitem
141        The freedom to redistribute copies so you can help your neighbor.
142    \stopitem
143    \startitem
144        The freedom to improve the program and release your improvements to the
145        public, so that the whole community benefits.
146    \stopitem
147\stopitemize
148
149You may exercise the freedoms specified here provided that you comply with the
150express conditions of this license. The principal conditions are:
151
152You must conspicuously and appropriately publish on each copy distributed an
153appropriate copyright notice and disclaimer of warranty and keep intact all the
154notices that refer to this License and to the absence of any warranty; and give
155any other recipients of the Program a copy of the GNU General Public License
156along with the Program. Any translation of the GNU General Public License must be
157accompanied by the GNU General Public License.
158
159If you modify your copy or copies of the program or any portion of it, or develop
160a program based upon it, you may distribute the resulting work provided you do so
161under the GNU General Public License. Any translation of the GNU General Public
162License must be accompanied by the GNU General Public License.
163
164If you copy or distribute the program, you must accompany it with the complete
165corresponding machine-readable source code or with a written offer, valid for at
166least three years, to furnish the complete corresponding machine-readable source
167code.
168
169Any of these conditions can be waived if you get permission from the copyright
170holder.
171
172Your fair use and other rights are in no way affected by the above.
173\stopcolor
174
175Many source filed mention the \quotation {\CONTEXT\ Development Team} as
176copyright holder. This is because over time users submit patches and whenever
177something happens to the main author, those involved in development can take
178over without the need to bother about derived work. In the end the \CONTEXT\
179group is the place to get more information.
180
181\stopsubject
182
183\startsubject[title={Recommendations}]
184
185Here are a few recommendations in case you want to distribute, extend of embed
186\CONTEXT\ in applications:
187
188\startitemize
189
190\startitem
191    You can best leave the code base untouched. Most of \CONTEXT\ provides hooks
192    and it's relatively easy to overload code. Leave the lower level system code
193    untouched: changes may backfire when you update. Asking for more hooks is the
194    best way to go.
195\stopitem
196
197\startitem
198    Put your own code in the right sub paths, i.e.\ modules approved by the
199    development team under \type {.../third}, and styles and whatever else under
200    \type {.../user}. This way your code will not interfere with existing code
201    and updating will give less problems. Keep in mind that \TEX\ systems have
202    their own way and order in locating files, and the load order often matters.
203\stopitem
204
205\startitem
206    Don't copy styles and change a few lines, but load the base one and
207    built|/|patch on top of that. In the end you may benefit from improvements to
208    the base style.
209\stopitem
210
211\startitem
212    Be original. The whole idea behind \CONTEXT\ is that you can write your own
213    styles. On the \CONTEXT\ mailing list as well as on the Wiki there are enough
214    advanced users to help you make a start.
215\stopitem
216
217\startitem
218    Don't hesitate to submit bugs reports and ask for extensions. It may even be
219    that what you want is already present but yet undocumented.
220\stopitem
221
222\startitem
223    If things don't work as expected, check to what extend your system matches
224    the (more or less) standard. We provide so called minimal \CONTEXT\ trees
225    that can serve as a reference. Because \CONTEXT\ evolves, make sure your
226    system is up to date. The \CONTEXT\ garden provides ways to install and
227    update the standard distribution.
228\stopitem
229
230\startitem
231    The scripts can best be called using \type {mtxrun}. This lessens dependencies
232    on the location in the tree and ensures upward compatibility. It also prevents
233    clashes with similar scripts.
234\stopitem
235
236\startitem
237    Some scripts depend on each other. Don't mess around with the existing
238    functionality and names of the scripts and then feed them back into the
239    standard distributions.
240\stopitem
241
242\stopitemize
243
244\stopsubject
245
246\startsubject[title={Documents}]
247
248The documentation is provided under another Creative Commons license:
249
250\startnarrower
251    \goto{Attribution ShareAlike}[url(bysa-simple)]
252\stopnarrower
253
254The manuals that are distributed with \CONTEXT\ comes with a rather liberal
255license. However, we try to adapt these documents to upgrades in the (sub)systems
256that they describe and derived work can therefore conflict with existing
257functionality and we cannot be held responsible for that. Many of the manuals
258contain characteristic graphics and personal notes or examples that make no sense
259when used out|-|of|-|context.
260
261The mentioned license says:
262
263\startcolor[blue]
264You are free:
265
266\startitemize
267    \startitem to copy, distribute, display, and perform the work \stopitem
268    \startitem to make derivative works \stopitem
269\stopitemize
270
271{\sc Attribution:} You must attribute the work in the manner specified by the
272author or licensor.
273
274{\sc Share Alike:} If you alter, transform, or build upon this work, you may
275distribute the resulting work only under a license identical to this one.
276
277\startitemize
278    \startitem
279        For any reuse or distribution, you must make clear to others the license
280        terms of this work.
281    \stopitem
282    \startitem
283        Any of these conditions can be waived if you get permission from the
284        copyright holder.
285    \stopitem
286\stopitemize
287
288Your fair use and other rights are in no way affected by the above.
289\stopcolor
290
291If you distribute \CONTEXT\ and related software on electronic media as part of
292\TEX\ distributions (either or not for money), you may also distribute the
293manuals and their sources in electronic form, preferable as provided by the
294maintainers of \CONTEXT.
295
296Keep in mind that logos and cover designs are not meant to be copied. We provide
297the source code for some manuals, but we don't always provide all graphics and
298other resources. For instance, in some manuals we use commercial fonts and you
299have to buy those yourself.
300
301We provide the typeset manuals at our website. Those are the official ones. We
302appreciate it if you do not to distribute manuals compiled on your own system as
303substitutes. The manuals are a showcase for what \CONTEXT\ provides. Help us to
304assure the quality.
305
306\stopsubject
307
308\startsubject[title={More information}]
309
310We're not going to fill \mathematics{n}~pages with legal stuff, so if you want to
311know more, you have to consult the web for the legalities mentioned. Here are a
312few starting points:
313
314\startlines
315\goto{\url[gpl-simple]}[url(gpl-simple)]
316\goto{\url[gpl-legal]}[url(gpl-legal)]
317\stoplines
318
319\startlines
320\goto{\url[bysa-simple]}[url(bysa-simple)]
321\goto{\url[bysa-legal]}[url(bysa-legal)]
322\stoplines
323
324\CONTEXT\ itself can be fetched from the main site or the garden:
325
326\startlines
327\goto{\url[pragma]}[url(pragma)]
328\goto{\url[install]}[url(install)]
329\stoplines
330
331These always ship the latest versions. Alternatively you can install the whole
332\TEX\ distribution, which is a yearly snapshot:
333
334\startlines
335\goto{\url[texlive]}[url(texlive)]
336\stoplines
337
338A starting point for support can be found at:
339
340\startlines
341\goto{\url[list]}[url(list)]
342\goto{\url[garden]}[url(garden)]
343\stoplines
344
345And of course there is the \CONTEXT\ group:
346
347\startlines
348\goto{\url[group]}[url(group)]
349\stoplines
350
351Bugs and feature requests can be registered at the collector:
352
353\startlines
354\goto{\url[collector]}[url(collector)]
355\stoplines
356
357Releases are announced at:
358
359\startlines
360\goto{\url[announce]}[url(announce)]
361\stoplines
362
363The developers can be met at:
364
365\startlines
366\goto{\url[development]}[url(development)]
367\stoplines
368
369\stopsubject
370
371\startsubject[title={Disclaimer}]
372
373To play safe we include a disclaimer here, taken from the BSD style license. For
374some reason such a text is always in unreadable capitals, so \unknown
375
376\start \txx \blue
377THIS SOFTWARE IS PROVIDED BY THE AUTHOR \quotation {AS IS} AND ANY EXPRESS OR
378IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
379OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
380IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
381INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
382NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
383DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
384THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
385(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
386THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
387\stop
388
389\unknown\ and don't bother discussing license issues and related things with us
390for the mere sake of discussing license stuff.
391
392\stopsubject
393
394\stopdocument
395