Changes

Jump to navigation Jump to search
1,486 bytes removed ,  09:45, 4 February 2019
updated conversion of mreadme.pdf
adapted to wiki markup.
This page is generated from mreadme.pdf on 20052019.0502.3104.
[[User:Taco|Taco]] 14:26, 31 May 2005 (CEST)----== Read Me First ==
== Read Me =Introduction === What licence suits best for a TeX like system is a matter of taste. Personallywe dislike any licence that needs more than a few pages of dense legal code toget the message across. A TeX related system like ConTeXt is a hybrid ofprograms, scripts and/or macro code as well as documentation and sample code,including graphics. TeX related systems also have a long standing tradition ofproviding support structures for users. In order to make support feasible, aTeX based system like ConTeXt assumes a certain logic and structure in theway the related files are named and organized in a tree structure. Even a smallchange in one of the elements may let such a system behave differently thanmanuals suggest. Swap a font, change some style defaults, leave out some pieces,and users may end up in confusion. A licence does not give a user any guarantees! In order to satisfy those responsible for distributing ConTeXt, we need tochoose a licence that makes them feel comfortable. Unfortunately we don't feelthat comfortable with a licence that does not provide the guarantees that asystem will not be adapted in such ways that the advertised behaviour changes. Onthe other hand, it is the responsibility of those distributing and extending thesystem to make sure that this does not happen. However, users should notautomatically assume that what they get shipped is the same as the original,which is why we stress that support (from our side) will only be given onunaltered systems. First of all, what is ConTeXt? It's just a bunch of macros, written in TeXand MetaPost, meant for typesetting documents. The macros are accompanied bysome scripts, written in Perl (mainly the older scripts) Ruby (also olderones) and Lua (the current fashion). The ConTeXt distribution comes with afew fonts, files that help manage resources (e.g. map files needed for MkII),as well as patterns (based on official ones, so this is a derived work). The ConTeXt distribution is packaged in a zip file organised in the TDSstructure. <table><tr><td><tt>cont-tmf.zip</tt></td><td>the main distribution that has all relevant files</td></tr><tr><td><tt>cont-tst.7z</tt></td><td>a bunch of test files that can also serve as examples</td></tr><tr><td><tt>cont-mpd.zip</tt></td><td>a MetaPost to PDF converter (not needed in ConTeXt)</td></tr><tr><td><tt>cont-ppc.zip</tt></td><td>a macro package for typesetting chemistry (not needed in ConTeXt)</td></tr><tr><td><tt>cont-sci.zip</tt></td><td>configuration files for using ConTeXt in the SciTE editor</td></tr></table> There are two flavours of ConTeXt: MkII and MkIV. The first one is frozen andwill not be extended. It runs on top of PdfTeX or XeTeX. The MkIV version isactively developed and runs on top of LuaTeX (an engine that is developedalongside ConTeXt but that can also be used for other macro packages).
=== Preamble === The documentation can be downloaded from our website or the Wiki. Some manualsship with source code. We might ship more source code but only when the source isstable and clean and can serve as an example.
This document presents That said, what licence information does apply? We need to distinguish between things thatresemble a program on the one hand and documentation on ConTeXt, a macro packagewritten in the typographical programming language TeXother hand. This documentWeis ''not'' an installation manual(currently) use a different licence for either of them. For installation of ConTeXt and itsaccompanying programs we refer to the following documents:
* [[http://www.pragma-ade.com/general/manuals/minstall.pdf How to install ConTeXt]]* [[http://www.pragma-ade.com/general/manuals/mtexexec.pdf TeXexec explained]]* [[http://www.pragma-ade.com/general/manuals/mtexutil.pdf TeXutil explained]]=== The Code ===
In addition you may need The program code (i.e. anything not under the introduction and <tt>/or referencedoc</tt> subtree) ismanual. There are more documents, but you need only these to getstarted. Unless you are going to change and redistribute ConTeXt, youcan quit reading now.distributed under the
<div style=== Introduction ==="color:gray;">: [http://creativecommons.org/licenses/GPL/2.0/ Creative Commons GNU GPL]</div>
'''[1.1]''' The name ConTeXt is reserved for For practical purposes distributers may also choose the distribution asLaTeX project licence,provided by Pragma ADE. This distribution which is copyrighted and licensed in thespirit of the gnu general public licenceconsidered to be a bit more TeX friendly. To prevent inconsistency in(BSD alike licences alsodistributions and to ease support, we will stress some details ofadapting sources and distributionsapply well for ConTeXt. )
In practice, users may forget about the legal part, if only because I haven'''[1.2]''' The ConTeXt distribution includes TeX macro files as well astsome utility programs written in Perleven read (and understood) it completely myself, Perl/Tk, and Ruby as well asgraphic macros written in the METAPOST language. The same conditionsso let's stick to what Creativeapply to all files. Commons makes of it:
'''[1.3]''' The logos associated to Pragma ADE, ConTeXt, TeXutil and related
programs are copyrighted by Pragma ADE and may not be used for other
purposes than their intended usage without permission.
'''[1<div style="color:gray;">The GNU General Public License is a Free Software license.4]''' Whenever one of the source files of ConTeXt mentions the fileLike any Free Software being copyrighted by Pragma ADElicense, it grants to you the conditions mentioned in thisdocument apply.four following freedoms:
=== Principles ===* The freedom to run the program for any purpose. * The freedom to study how the program works and adapt it to your needs. * The freedom to redistribute copies so you can help your neighbour. * The freedom to improve the program and release your improvements to the public, so that the whole community benefits.
'''[2.1]''' Pragma ADE originally developed ConTeXt for producing highlystructured documents as used in educational settings and processindustry. Currently ConTeXt is used by publishers and in education, inYou may exercise the freedoms specified here provided that you comply with theprofit and non profit organizationsexpress conditions of this license. There The principal conditions are also numerous privateusers. These all depend on ConTeXt being stable system.:
'''[2.2]''' One You must conspicuously and appropriately publish on each copy distributed anappropriate copyright notice and disclaimer of warranty and keep intact all the objectives of ConTeXt is the low entry level, notices thatis, for day-refer to this License and to-day use no special technical (the absence of any warranty; and no in-depth TeX)giveknowledge is neededany other recipients of the Program a copy of the GNU General Public Licensealong with the Program. This is reflected in Any translation of the user interface. We don'texpect users to GNU General Public License must be experts on installing TeX and adapting macros forlocal useaccompanied by the GNU General Public License.
'''[2.3]''' We try to keep ConTeXt in sync with developments inIf you modify your copy or copies of the program or any portion of it, or developpublishing. So far this has lead to support for output formats likea program based upon it, you may distribute the resulting work provided you do sopdf and alternative coding standards like xmlunder the GNU General Public License. It has also resulted inAny translation of the GNU General Publica couple of user interfaces and toolsLicense must be accompanied by the GNU General Public License.
'''[2.4]''' Further development of ConTeXt takes place at Pragma ADE If you copy or distribute the program, you must accompany it withthe help and input from some active users. All kinds of comment fromcompleteusers is welcomed and will be taken seriously. When we talk aboutcorresponding machine-readable source code or with a written offer, valid for atConTeXtleast three years, we refer to furnish the version as distributed by Pragma ADE andcomplete corresponding machine-readable sourcedescribed in the official reference manualcode.
'''[2.5]''' ConTeXt consists Any of several series of modules, that these conditions can berecognized by the fact that waived if you get permission from the filename starts with four charactersand a dash. These core modules take care of languages, fonts, generaltypography, data abstraction, and manipulations. On top of this core,domain and task specific modules and styles are (and will become)available. These can be recognized by their filename that start with acopyrightcharacter followed by a dashholder.
'''[2.6]''' For special purposes, not covered by existing functionality,users can write their own extensions. ConTeXt provides hooks into thecore routines. These Your fair use and other rights are documented in no way affected by the source codeabove. </div>
'''[2Many source filed mention the <q>ConTeXt Development Team</q> ascopyright holder.7]''' ConTeXt This is available for free for everyone who want because over time users submit patches and wheneversomething happens to usethe main author, those involved in development can takeitover without the need to bother about derived work. Distributors are free to choose between In the end the latest officialConTeXtrelease and group is the (in most cases stable) beta versionplace to get more information.
'''[2.8]''' Experimental, and thereby potentially non-stable, versions aswell as certain dedicated modules, will be distributed under differentconditions. === Recommendations ===
'''[2.9]''' Modules Here are a few recommendations in case you want to ConTeXt or adapted source code written by Pragma ADEfor third parties as part distribute, extend of a project may not be distributed outsideembedthat organization. They may become part of the public distribution,upon mutual agreement.ConTeXt in applications:
=== Public version ===* You can best leave the code base untouched. Most of ConTeXt provides hooks and it's relatively easy to overload code. Leave the lower level system code untouched: changes may backfire when you update. Asking for more hooks is the best way to go.
'''[3* Put your own code in the right subpaths, i.e. modules approved by the development team under <tt>.../third</tt>, and styles and whatever else under <tt>...1]''' ConTeXt is available as free software /user</tt>. This way your code will not interfere with existing code and updating will give less problems. Keep in mind that TeX systems have their own way and order in locating files, and the spirit of the gnugeneral public licenceload order often matters.
* Don'''[3.2]''' This public version is t copy styles and change a few lines, but load the "official public ConTeXtdistribution". However, ConTeXt as part of base one and built/patch on top of that. In the end you may benefit from improvements to the TeXdistributions supported by user groups can also be classified asofficialbase style.
'''[3* Be original.3]''' The official version (i.ewhole idea behind ConTeXt is that you can write your own styles. On the original zipped archiverecognized by ConTeXt mailing list as well as on the prefix cont-) may only be redistributed as Wiki there are enough advanced users to help you make a wholeand under this licencestart.
* Don'''[3.4]''' This licence does not automatically apply t hesitate to third partysubmit bugs reports and ask for extensions. It may even be that what you want is already present but yet undocumented.
=== Third party developments ===* If things don't work as expected, check to what extend your system matches the (more or less) standard. We provide so called minimal ConTeXt trees that can serve as a reference. Because ConTeXt evolves, make sure your system is up to date. The ConTeXt garden provides ways to install and update the standard distribution.
'''[4* The scripts can best be called using <tt>mtxrun</tt>.1]''' This sections will not introduce limitations lessens dependencies on the location in use thatconflict with the gnu general public licencetree and ensures upward compatibility. We only want to makesure that the average user will get the ConTeXt they expect and thatwe can continue to support users efficientlyIt also prevents clashes with similar scripts.
'''[4* Some scripts depend on each other.2]''Don' Users are encouraged to develop modules cq. layout definitionfiles for ConTeXt. However, t mess around with the interface existing functionality and names of such modules should fitthe general scheme philosophyscripts and then feed them back into the standard distributions.
'''[4.3]''' Keywords and command names should conform to the already definedones and therefore not clash with existing functionality. An exampleof extending the user interface can be seen in the ppchTeXmodule. === Documents ===
'''[4.4]''' On request, additional keywords and command names can beapproved and/or assigned by the ConTeXt Task Force and, when accepted,will be added to the validated definition files. The same applies tothe names of files and auxiliary variables. These should conform tothe naming scheme laid down in the documentation. is provided under another Creative Commons licence:
'''[4.5]''' Third party modules (and layout files) will not automatically<div style="color:gray;">become part of the ConTeXt distribution, but will be collected and:Attribution NonCommercial ShareAlike distributed separately. One reason for this is that they fall outside</div>the maintainance responsibility of Pragma ADE. This also means thatfor instance in the texmf directory structure, the context/base,context/extra and context/sample locations are reserved for theofficial distribution. Additions should go into context/third and userspecific things into context/user. one says:
'''[4.6]''' We strongly advice users who write their own macros for ConTeXt<div style="color:gray;">You are free: * to copy, distribute,display, and perform the work * to package them in document specific environments or third partymodules (prefixed by t-). make derivative works
'''[4.7]''' Users may not change ATTRIBUTION: You must attribute the official distribution and redistributethat changed version as official. This will ensure work in the integrity ofConTeXt. Local settings cq. bug fixes can be added in manner specified by the filescont-sys and cont-new. Distributers may add configuration settings tocont-usr and cont-sysauthor or licensor.
'''[4.8]''' When adapted versions of ConTeXt are distributed, these versionsmust contain the original distribution as a separate item. The runtimeversions (format files) must have different names and changed filesmust have an additional \writestatus message, expressing thatsomething is changed. The rationale behind NONCOMMERCIAL: You may not use this is that some modulesare generic, and are sometimes distributed on request separately. Whendistributing self contained modules and styles, a full distribution oforiginals is not requiredwork for commercial purposes.
'''[4.9]''' Because many TeX systems support recursive directory searchSHARE ALIKE: If you alter, transform,those who write extensions or change filesbuild upon this work, must make sure that you may distribute theoriginal ConTeXt does not suffer from loading the wrong files. Werealize that resulting work only under a license identical to this is not always easy, but please keep in mind thatthere are many users who cannot sort out these problems. Together wemust guarantee that when users want to run original ConTeXt, nothingunexpected is loaded, because it makes support nearlyimpossibleone.
'''[4.10]''' Because ConTeXt is a monolithic system* For any reuse or distribution, and because programminghooks are provided, adaptations and extensions should be put and/orloaded in you must make clear to others the file cont-new which itself is loaded at run timelicense terms of this work. Thatway, users * Any of these conditions can still benefit be waived if you get permission from official updatesthe copyright holder.
'''[4Your fair use and other rights are in no way affected by the above.11]''' The auxiliary programs may be adapted to local conditions, suchas operating systems specifics. The functionality however must not bechanged. </div>
'''[4.12]''' The same rules apply If you distribute ConTeXt and related software on electronic media as part ofTeX distributions (either or not for money), you may also distribute the METAPOST macro files manuals and their sources in electronic form, preferable as for provided by theTeX macro filesmaintainers of ConTeXt.
Keep in mind that logos and cover designs are not meant to be copied. We providethe source code for some manuals, but we don'''[4t always provide all graphics andother resources.13]''' Support of the official public version of ConTeXt is availableFor instance, in some manuals we use commercial fonts and youfrom the ConTeXt mailing list hosted by the ntghave to buy those yourself.
=== Manuals ===We provide the typeset manuals at our website. Those are the official ones. Weappreciate it if you do not to distribute manuals compiled on your own system assubstitutes. The manuals are a showcase for what ConTeXt provides. Help us toassure the quality.
'''[5.1]''' User manuals, reference documentation, module related manuals,quick reference guides, up-to-date documents, faqs, documentedsources, are available in printable and/or electronic form at thePragma ADE site and its mirrors. These documents are copyrighted byPragma ADE and serve as reference to the official version. You mayprint them and give away copies. === More information ===
We're not going to fill ''[5.2]'n'' Users are invited pages with legal stuff, so if you want to provideadditional documentation know more, you have to usersconsult the web for the legalities mentioned. The official documentation providedHere are aby Pragma ADE is maintained by and generated at Pragma ADE andavailable at its website. Pointers to third party contributions can befound at the Pragma ADE website.few starting points:
'''[5.3]''' Because the manuals provided by Pragma ADE are also examples ofwhat can be done with ConTeXt, their layout is bound to thesedocumentshttp://creativecommons. This also applies to the ConTeXt demonstrationsuiteorg/licenses/GPL/2. Therefore, in order to avoid confusion, we strongly advice0/ <br>authors of third party documentation and demos not to use the samelayout characteristics, graphics and special tricks http://creativecommons. Examples ofcoding and tricks can be found in the style files that come withConTeXtorg/licenses/GPL/2.0/legalcode
=== Guarantees === http://creativecommons.org/licenses/by-nc-sa/2.5/ <br> http://creativecommons.org/licenses/by-nc-sa/2.5/legalcode
'''[6.1]''' Pragma ADE cannot guarantee ConTeXt itself can be fetched from the typographic quality and main site or thefunctionality of the ConTeXt output. garden:
'''[6.2]''' Typographic optimizations will be implemented and wishescqhttp://www. suggestions of users will be be honoured when possiblepragma-ade. The bestcom <br>way to communicate this is the ConTeXt mailing list http://context.aanhet. net
'''[6These always ship the latest versions.3]''' When additional functionality Alternatively you can install the wholeTeX distribution, which is provided, downwardcompatibility will be guarded as good as possible. a yearly snapshot:
'''[6.4]''' Users of experimental modules should be aware of the fact thatdue to further optimization and consistency, the functionality willonly be stable when explicitly statedhttp://www. The common user will hardlynotice this limitationtug. org/texlive
'''[6.5]''' Some core modules A starting point for support can be classified as generic, that is, theywork with other macro packages as well (for instance supp-pdf). You mayinstall them separately on your system, but in order to preventconflicts in versions, we strongly advice separating them from thedistributions. found at:
'''[6 http://www.ntg.6]''' nl/mailman/listinfo/ntg-context <br> Undocumented macros and functionality are subjected tooptimizations and relying on their presence can be "dangerous"http://contextgarden.net
=== Distribution === And of course there is the ConTeXt group:
'''[7.1]''' The official ConTeXt archive is available at the Pragma ADE wwwsite, as well as on mirrors of this site, provided by the ntg, ctan,and othershttp://group. The free TeX distributions teTeX and fpTeX can beconsidered as a references to integrating ConTeXt into other TeXsystemscontextgarden. net
'''[7.2]''' We hereby grant permission to Bugs and feature requests can be registered at the de facto official TeXdistributors teTeX, fpTeX and TeXlive to replace this licence withtheir own, i.e. their licence may supersede or enhance this one.collector:
http://tracker.luatex.org
'''[7.3]''' ConTeXt may be distributed as part of a public distribution inthe spirit of free distributions. The authors of ConTeXt appreciatebeing notified on this. Releases are announced at:
'''[7 http://www.4]''' Each distribution of ConTeXt should include a copy of this textntg.nl/mailman/listinfo/ann-context
=== Additional disclaimers ===The developers can be met at:
Because we don't want to be confronted with funny claims as a sideeffect of providing free software, we add a few disclaimers http://www. ntg.nl/mailman/listinfo/dev-context
'''[8.1]''' By modifying or distributing the program (or any work based onthe program), you indicate your acceptance of this license to do so,and all its terms and conditions for copying, distributing ormodifying the program or works based on it. Nothing other than thislicense grants you permission to modify or distribute the program orits derivative works. These actions are prohibited by law. If you donot accept these terms and conditions, do not modify or distribute theprogram. === Disclaimer ===
'''[8.2]''' The program is provided to you "as is"To play safe we include a disclaimer here, without warrantytaken from the BSD style licence. ThereForsome reason such a text is no warranty for the programalways in unreadable capitals, either expressed or implied,including, but not limited to, the implied warranties ofmerchantability and fitness for a particular purpose andnoninfringement of third party rightsso . The entire risk as to thequality and performance of the program is with you. should the programprove defective, you assume the cost of all necessary servicing,repair or correction.
'''[8<div style="color:gray;">THIS SOFTWARE IS PROVIDED BY THE AUTHOR “AS IS” AND ANY EXPRESS ORIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIESOF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.3]''' In no event unless required by applicable law or agreed to inwriting will licensorIN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, or any other party who may modify and/orredistribute the program as permitted aboveINCIDENTAL, SPECIAL, EXEMPLARY, be liable to you forOR CONSEQUENTIAL DAMAGES (INCLUDING, BUTdamagesNOT LIMITED TO, including any generalPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, specialDATA, incidental or consequentialOR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANYdamages arising out of the use or inability to use the programTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(including but not limited to loss of data or data being renderedINCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OFinaccurate or losses sustained by you or third parties or a failure ofthe program to operate with any other programs)THIS SOFTWARE, even if such holderEVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.or other party has been advised of the possibility of such damages.</div>
... and don't bother discussing licence issues and related things with us
for the mere sake of discussing licence stuff.
: PRAGMAHans Hagen: PRAGMA Advanced Document Engineering : Ridderstraat 27 : 8061GH Hasselt NL : tel: +31 (0)38 477 53 69 : email: [mailto:pragma@wxs.nl pragma@wxs.nl]: internet: [http://www.pragma-ade.com www.pragma-ade.com]

Navigation menu