diff options
author | Context Git Mirror Bot <phg42.2a@gmail.com> | 2016-08-01 13:39:31 +0200 |
---|---|---|
committer | Context Git Mirror Bot <phg42.2a@gmail.com> | 2016-08-01 13:39:31 +0200 |
commit | c44a9d2f89620e439f335029689e7f0dff9516b7 (patch) | |
tree | 1062a464cb13362d82598c41c437ab1c7eb4f236 /doc/context/sources/general/manuals/start/en | |
parent | 665f9095475ffcd1c8750546727c75e5486a266f (diff) | |
download | context-c44a9d2f89620e439f335029689e7f0dff9516b7.tar.gz |
2016-08-01 13:07:00
Diffstat (limited to 'doc/context/sources/general/manuals/start/en')
60 files changed, 7744 insertions, 0 deletions
diff --git a/doc/context/sources/general/manuals/start/en/hasseltbook.bib b/doc/context/sources/general/manuals/start/en/hasseltbook.bib new file mode 100644 index 000000000..ea7bbfd31 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/hasseltbook.bib @@ -0,0 +1,7 @@ +@INBOOK{book01, + author = "Jonker, J.", + title = "From Hasselt to America", + publisher = "Bookplan Publishers", + year = "2012", + chapter = "1.2", +} diff --git a/doc/context/sources/general/manuals/start/en/hasseltbook.pdf b/doc/context/sources/general/manuals/start/en/hasseltbook.pdf Binary files differnew file mode 100644 index 000000000..03c894ff4 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/hasseltbook.pdf diff --git a/doc/context/sources/general/manuals/start/en/hasseltbook.tex b/doc/context/sources/general/manuals/start/en/hasseltbook.tex new file mode 100644 index 000000000..9c0d319f5 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/hasseltbook.tex @@ -0,0 +1,30 @@ + +\starttext + +\startstandardmakeup + \midaligned{\tfd Festivities in Hasselt} +\stopstandardmakeup + +\completecontent + +\startchapter[title=Introduction] + An introduction. +\stopchapter + +\startchapter[title=Kingsday] + Something about the Kingsday in Hasselt.\index{Kingsday} +\stopchapter + +\startchapter[title=Hassailt] + Something about Hassailt.\index{Hassailt} +\stopchapter + +\startchapter[title=Euifeest,reference=euifeest] + Something about the Euifeest.\index{Euifeest} +\stopchapter + +\completeindex + +\stoptext + +\stoptext diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-alignments.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-alignments.tex new file mode 100644 index 000000000..327bc8a6b --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-alignments.tex @@ -0,0 +1,73 @@ +\startcomponent ma-cb-en-alignments + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Alignment] + +\index{alignment} + +\Command{\tex{setupalign}} +\Command{\tex{setup tolerance}} +\Command{\tex{rightaligned}} +\Command{\tex{leftlines}} +\Command{\tex{midaligned}} + +Horizontal and vertical alignment can be set up with: + +\shortsetup{setupalign} + +Single lines can be aligned with: + +\starttyping +\rightaligned{} +\leftaligned{} +\midaligned{} +\stoptyping + +An example can illustrate the alignment behavior: + +\startbuffer +\leftaligned {Hasselt was built on a sandhill.} +\midaligned {Hasselt was built on the crossing of two rivers.} +\rightaligned {Hasselt's name stems from hazelwood.} +\stopbuffer + +\typebuffer + +After processing this would look like: + +\getbuffer + +Alignment of a paragraph is done with: + +\shortsetup{startalignment} + +\startbuffer +\startalignment[flushright,nothyphenated] + For Hasselt the 15th and 16th century were relatively unstable times. + There were uprises and disputes with neighbouring cities. To be + able to defend themselves the city council ordered a number of + arquebuses (very primitive firearms). Fourteen of these have survived + and now form one of the greatest arquebus collections in Europe. +\stopalignment +\stopbuffer + +\typebuffer + +This will become a rightaligned paragraph without hyphenations: + +\getbuffer + +In case of alignment you can specify a tolerance and the direction (vertical or +horizontal). Normally the tolerance is \type{verystrict}. In colums you could +specify \type{verytolerant}. The tolerance in this manual is: + +\starttyping +\setuptolerance[horizontal,verystrict] +\stoptyping + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-backpage.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-backpage.tex new file mode 100644 index 000000000..bb7ae0250 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-backpage.tex @@ -0,0 +1,40 @@ +\startcomponent ma-cb-en-backpage + +\enablemode[**en-us] + +\project ma-cb + +This manual describes some features of \CONTEXT, a document +production system, based on \TEX. + +\vfil + +\CONTEXT\ offers the user a flexible and high quality +typesetting environment. No in||depth knowledge of \TEX\ +is needed. The parameter driven character of \CONTEXT\ +enables users to define their own layout rather easy. + +\vfil + +\CONTEXT\ is developed and tested in a production +environment and is used for typesetting simple books as +well as complex documents, paper and/or screen based. This +introduction manual describes the functionality needed for +everyday publications, like manuals and educational +materials. + +\vfil + +This manual is also available as an interactive document, be +it in a bit different layout. The macro package \CONTEXT, +some more advanced examples and additional information can +be found at www.pragma-ade.com. + +\vfil + +PRAGMA ADE \break +Ridderstraat 27 \break +8061 GH Hasselt NL \break +www.pragma-ade.com + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-bibliography.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-bibliography.tex new file mode 100644 index 000000000..1b8451934 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-bibliography.tex @@ -0,0 +1,63 @@ +\startcomponent ma-cb-en-bibliography + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Bibliography] + +\index{bibliography} +\index{\BIBTEX} + +\Command{\tex{setuppublications}} +\Command{\tex{placepublications}} +\Command{\tex{setupbibtex}} + +\CONTEXT\ support the \BIBTEX\ way of managing article and book references. The data +is stored in a \type{.bib} file. A data entry in a \BIBTEX\ data file could be: + +\startbuffer +@INBOOK{book01, + author = "Jonker, J.", + title = "From Hasselt to America", + publisher = "Bookplan Publishers", + year = "2012", + chapter = "1.2", +} +\stopbuffer + +\typebuffer + +After loading the database with \type{\setupbibtex[database=hasseltbook]} the following +command is available: + +\setupbibtex[database={hasseltbook},sort=author] +\setuppublications[refcommand=authoryear] + +\startbuffer +Please refer to \cite[book01] for more information on famous people +that were born in Hasselt. +\stopbuffer + +\typebuffer + +Which would produce: + +\getbuffer + +In an appendix you can place the complete book list with: + +\startbuffer +\placepublications[criterium=text] +\stopbuffer + +\typebuffer + +At this moment (2013 -- 2014) the bibliography mechanism is being completely +overhauled, so please visit the \goto {\CONTEXTWIKI} [ url +(http://wiki.contextgarden.net) ] and the \goto {Pragma ADE website} [ url +(http://www.pragma-ade.com/overview.htm) ] regularly for information. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-chemical.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-chemical.tex new file mode 100644 index 000000000..3919ccb01 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-chemical.tex @@ -0,0 +1,77 @@ +\startcomponent ma-cb-en-chemical + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Chemical stuf,reference=chemical] + +\index{chemistry} +\index{chemical equitation} + +\Command{\tex{}chemical} + +Chemical structures may look very impressive. + +\startbuffer +\startchemical[scale=small,width=fit,top=3000,bottom=3000] + \chemical[SIX,SB2356,DB14,Z2346,SR3,RZ3,SR6,-RZ6,+RZ6] + [C,N,C,C,H,H] + \chemical[PB:Z1,ONE,Z0,MOV8,Z0,SB24,DB7,Z27,PE][C,C,CH_3,O] + \chemical[PB:Z5,ONE,Z0,MOV6,Z0,SB24,DB7,Z47,PE][C,C,H_3C,O] + \chemical[SR24,RZ24][CH_3,H_3C] + \bottext{Compound A} +\stopchemical +\stopbuffer + +\placeformula[-] +\startformula + \getbuffer +\stopformula + +\CONTEXT\ relies on \METAPOST\ to draw these kind of chemical structures. +Although these chemical structures are defined with only two or three commands, +it takes some practice to get the right results. This is how the input looks: + +\typebuffer + +Chemical reactions can be typeset within a paragraph or as a display formula with +the \type{\inlinechemical} and \type{\startchemicalformula} commands: + +\startbuffer +\definefloat + [chemicalformula] + [chemicalformulas] + +One of the steps in the Hasselt canal water treatment is the removal of +phosphate by means of a chemical reaction with iron: + +\placechemicalformula[none][]{} + {\startchemicalformula + \chemical{Fe(OH)_3}{iron hydroxide} + \chemical{PLUS} + \chemical{H_3PO_4}{phosphoric acid} + \chemical{GIVES}{\hphantom{whatever}} + \chemical{FePO_4}{iron phosphate} + \chemical{PLUS} + \chemical{H_2O}{water} + \stopchemicalformula} + +The \inlinechemical{FePO_4} is a solid and precipitates in water. It +is filtered and re-used as a furtilizer resource. +\stopbuffer + +\getbuffer + +This is defined by: + +\typebuffer + +The use of the chemical commands is described in the \goto{PPCHTeX Manual}[ url(manual:chemic) ] +and the example manual \goto{Chemical Formulas in \CONTEXT} [ url(manual:chemic-ex) ]. + +\stopchapter + +\stopcomponent + + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-citations.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-citations.tex new file mode 100644 index 000000000..b0e416ee0 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-citations.tex @@ -0,0 +1,64 @@ +\startcomponent ma-cb-en-citations + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Citations and quotations, reference=quotations] + +\index{citation} +\index{quote} + +\Command{\tex{quote}} + +The consistent use of quote and quotation marks in the running text is invoked by +the use of \type{\quote} or \type{\quotation}. For longer text fragments you can use: + +\shortsetup{startquotation} + +\startbuffer +In the book \quote{Hasselt, beelden van een middeleeuwse stad} it says: +\startquotation +Het stadhuis wordt voor het eerst vermeld in 1431. Oorspronkelijk +is het een houten huis, dat wordt afgebroken om plaats te maken voor +een nieuw stadhuis van steen. Dit wordt echter halverwege de 16e eeuw +ook afgebroken en vervangen door een nog groter pand. Het nieuwe +stadhuis wordt weer in dezelfde fraaie stijl opgebouwd. De bestuurders +laten daarmee zien dat het is gebouwd in een tijd van grote welvaart. +\stopquotation +\stopbuffer + +\typebuffer + +In the example below you can see that quotation is language sensitive: + +\startbuffer +\nl Hij zei tegen me: \quotation{In Hasselt noemen ze dat + \quote{noaberschop} of zoiets.} + +\en He told me: \quotation{In Hasselt they call this + \quote{noaberschop} or something like that.} + +\de Er sagte zu mir: \quotation{In Hasselt nennt man das + \quote{noaberschop} oder so etwas.} + +\fr Il a dit: \quotation{À Hasselt on c'appelle \quote{noaberschop} + ou quelque chose comme ça.} +\stopbuffer + +\typebuffer + +Note the automatic change of the quotation marks in case of a quote within a +quote. + +\startpacked +\getbuffer +\stoppacked + +You can alter the default settings with: + +\shortsetup{setuplanguage} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-color.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-color.tex new file mode 100644 index 000000000..1cfeadf9a --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-color.tex @@ -0,0 +1,71 @@ +\startcomponent ma-cb-en-color + +\project ma-cb + +\startchapter[title=Color] + +\index{color} + +\Command{\tex{setupcolors}} +\Command{\tex{color}} +\Command{\tex{definecolor}} + +Text, frames or backgrounds can be set in color with: + +\shortsetup{color} + +Default the basic colors are available. Basic colors are for example +red, white and blue. A color like orange can be defined with: + +\shortsetup{definecolor} + +You can define orange like this: + +\startbuffer[a] +\definecolor [darkorange] [c=0.0,m=0.60,y=1.00,k=0.0] +\definecolor [middleorange] [.5(darkorange)] +\stopbuffer + +\typebuffer[a] + +\getbuffer[a] + +It is of good practice to check (combinations of) colors on a larger +surface: + +\startbuffer +\blackrule[width=\hsize,height=1cm,color=red,after=] +\blackrule[width=\hsize,height=1cm,color=white,after=] +\blackrule[width=\hsize,height=1cm,color=blue,after=] +\blackrule[width=\hsize,height=1cm,color=darkorange] +\stopbuffer + +\typebuffer + +so you can see if they fit together: + +\blank + +\getbuffer + +A color can be invoked in a number of ways: + +\startbuffer +\startcolor[red] +On {\darkorange Kingsday} {\blue Hasselt} turns into a +\color[darkorange]{colorfull} city. +\stopcolor +\stopbuffer + +\typebuffer + +\getbuffer + +More information on the use of color models, transparency and palets can be found +on the \goto {\CONTEXTWIKI} [ url (http://wiki.contextgarden.net/Color) ] +and in the +\goto {\em Color Separation} [ url (manual:color) ] manual. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-columns.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-columns.tex new file mode 100644 index 000000000..06bb30259 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-columns.tex @@ -0,0 +1,154 @@ +\startcomponent ma-cb-en-columns + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Columns] + +\index{columns} + +\Command{\tex{startcolums}} +\Command{\tex{setupcolumns}} +\Command{\tex{column}} + +Simple sections of text can be typeset in columns. If you preceed a text fragment +by \type{\startcolumns} and close the text fragment by \type{\stopcolumns} +everything in between will be set in columns. + +\shortsetup{startcolumns} + +Let's give an example: + +\startbuffer +\startcolumns[n=3,tolerance=verytolerant] + Hasselt is an old Hanseatic City, situated 12~km north of Zwolle + at the river Zwartewater. + + ... + + Furthermore some events of special interest should be + mentioned. Every year at the end of August Hasselt celebrates + the \quote{Eui Festival} (hay festival). +\stopcolumns +\stopbuffer + +\typebuffer + +\startbuffer +\hyphenation{Ste-pha-nus} +\startcolumns[n=3,tolerance=verytolerant] +Hasselt is an old Hanseatic City, situated 12~km north of Zwolle at +the river Zwartewater. + +The city has a long history since obtaining the city charter around +1252. Part and parcel of this history can be traced back to a large +number of monuments to be admired in the city center. + +There you will find the St. Stephanus church, a late gothic church +dating back to 1479 with a magnificent organ. The former Municipal +Building is situated on The Market Place. Constituted between 1500 +and 1550 it houses a large collection of weapons, amongst which one +of the largest collection of black powder guns (haakhussen) in the +whole world should be mentioned. + +Furthermore there is a corn windmill \quote{The Swallow}, dating back to +1748 as well as the \quote{Stenendijk}, a unique embankment and the last +shell limekiln in Europe still in full operation. + +The city center with the townmoat adorned by lime-trees, the Van +Stolkspark and the hustle and bustle at the docks are ideally suited +for a stroll. + +The area around Hasselt is also worth mentioning. In wintertime +polder Mastenbroek harbours large numbers of geese. In summertime the +hamlets Gen\-ne, Streukel and Celle\-mui\-den form, together with the very +rare lapwing flowers (Lat. Fritillaria meleagris) found on the banks +of the river Zwatewater, the ideal surroundings for walking or +cycling trips. + +Hasselt also is a very important center for watersports. The lakes of +northwest Overijssel, the river IJssel, the Overijsselse Vecht and +the Randmeren are within easy reach from the yacht harbour `De +Molenwaard'. Sailing, fishing, swimming and ca\-noe\-ing can be fully +enjoyed in Hasselt. + +Furthermore some events of special interest should be +mentioned. Every year at the end of August Hasselt celebrates the +\quote{Eui Festival} (hay festival). +\stopcolumns +\stopbuffer + +The result will be a three column text. + +\start +\switchtobodyfont[9pt] +\getbuffer +\stop + +If possible a new column can be enforced with \type{\column}. You can set up +columns with: + +\shortsetup{setupcolumns} + +In most cases you will obtain a better result by type setting the text on +\quote{grid}. This is done by typing \type{grid=yes} in the command \type +{\setuplayout}. + +If you want to use columns within a framed text \type{\start ... \stopframedtext} +there is the simple column mechanism. + +\startbuffer +\startframedtext[background=color,backgroundcolor=gray] +\startsimplecolumns + In Hasselt's local newspaper there was a column on the + local customs during New Years Eve. + ... + \midaligned{\inlinechemical{CaC_2,+,2H_2O,GIVES,C_2H_2(g),+,Ca(OH)_2}} + ... + Nowadays the heavy metal lid of the milk can is replaced by + a football. This does not reduce the sound but it is much + saver. +\stopsimplecolumns +\stopbuffer + +\typebuffer + +\startbuffer +\startframedtext[background=color,backgroundcolor=gray,width=\textwidth] +\startsimplecolumns + In Hasselt's local newspaper there was a column on the + local customs during new years Eve. Next to the more + general custom of eating Dutch doughnuts (oliebollen) + and lighting fireworks there is the carbide shooting. + What you need is an oldfashioned metal milk can, carbide, + a little water and a lighter. + + The carbide and water is mixed in the closed milk can and + will produce \inlinechemical{C_2H_2} gas (acetylene), via: + + \midaligned{\inlinechemical{CaC_2,+,2H_2O,GIVES,C_2H_2 (g),+,Ca(OH)_2}} + + The volatile acetylene gas in the milk can is ignited via a small + opening in the can. The result is a very loud detonation and the lid + flies off. + + It will not surprise you that Hasselts youth has a designated + shooting ground for carbide shooting. Nowadays the heavy + metal lid of the milk can is replaced by a football. This + does not reduce the sound but it is much saver! +\stopsimplecolumns +\stopframedtext +\stopbuffer + +This will result in: + +\getbuffer + +There is an advanced column mechanism available that is described in the +\goto {\em Columns} [ url (manual:columns) +] manual. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-commandlist.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-commandlist.tex new file mode 100644 index 000000000..d14d9d202 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-commandlist.tex @@ -0,0 +1,16 @@ +\startcomponent ma-cb-en-commandlist + +\project ma-cb + +Here we summarize the commands we introduced in the previous chapters. This is +just a selection of the whole repertoire of \CONTEXT\ commands. Those who want to +see them all can take a look at the more extensive manual or the {\em Quick +Reference Manuals} that give a complete overview of all \CONTEXT||commands. + +Arguments that are typeset {\sl slanted} are optional and can be omited. The +number points to the page where the command is explained. Black arrows indicate +that the command is only of use in interactive documents and gray arrows tell us +that additional functionality is provided in interactive mode. Keep in mind that +we only show the commands we described in this manual, there are many more. + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-commands.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-commands.tex new file mode 100644 index 000000000..df0d2a293 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-commands.tex @@ -0,0 +1,94 @@ +\startcomponent ma-cb-en-commands + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Defining commands / macros] + +\CONTEXT\ is a set of macros based on \TEX. \TEX\ is a programming language as +well as a typographical system. This means that you can do the programming +yourself if you need that kind of flexability. + +You can define a new command with: + +\shortsetup{define} + +The next example will explain its meaning. + +You may have a well illustrated document and you are tired of typing: + +\startbuffer +\placefigure + [here,force] + [fig:logical name] + {Caption.} + {\externalfigure[filename][width=5cm]} +\stopbuffer + +\typebuffer + +You could define your own command with a few variables like: + +\startitemize[packed] +\item logical name +\item caption +\item file name +\stopitemize + +Your command definition and call could look something like +this: + +\startbuffer +\define[3]\myputfigure + {\placefigure + [here,force][fig:#1] + {#2}{\externalfigure[#3][width=5cm]}} + +\myputfigure{lion}{The Dutch lion is a sentry.}{ma-cb-13} +\stopbuffer + +\typebuffer + +From then on the \type{\myputfigure} is available. +Between brackets \type{[3]} indicates that you want to use three variables +\type{#1}, \type{#2} and \type{#3}. In the command call \type{\myputfigure} you +have to place these variables between curly braces. The result is shown in +\in{figure}[fig:lion]. + +\getbuffer + +Very sophisticated commands can be programmed, but this is left to your own +inventiveness. + +In addition to defining commands you can also define \type{\start...\stop} +command pairs. + +\shortsetup{definestartstop} + +For example: + +\startbuffer +\definestartstop + [attention] + [before=\blank\startmarginrule, + after=\stopmarginrule\blank] + +\startattention +{\em Hasselter Juffers} are sweet cookies but the name is no +coincidence. On July 21 in 1233 the {\em Zwartewaterklooster} +(Blackwater Monastery) was founded. The monastery was meant +for unmarried girls and women belonging to the nobility of +Hasselt. These girls and women were called {\em juffers}. +\stopattention +\stopbuffer + +\typebuffer + +This will result in: + +\getbuffer + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-composedcharacters.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-composedcharacters.tex new file mode 100644 index 000000000..59c176004 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-composedcharacters.tex @@ -0,0 +1,55 @@ +\startcomponent ma-cb-en-composedcharacters + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Composite characters] + +\index{accents} +\index{foreign characters} + +In \in{chapter}[special chars] you have already seen that you have to type more +than one token to obtain special characters like \# \$ \% \& \_ $\{$ and $\}$. + +Characters with accents for example can be composed or coded with specific +\CONTEXT\ commands in order to display them on paper. In case you have a text +editor that can display utf8 you can type the composed characters directly. + +It is not within the scope of this manual to go into accented characters in math +mode. See the {\TEX Book} by Donald E. Knuth on that subject. + +\in{Table}[tab:composed-characters] shows a few examples and the way you can code +composed characters. + +\placetable + [here,force] + [tab:composed-characters] + {Composed characters.} + {\starttable[|c|l|l|c|] + \HL + \NC \bf Character \NC \bf Composed \NC \bf \CONTEXT\ command \NC \bf UTF8 \NC\SR + \HL + \NC ü \NC \type{\"u} \NC \type{\uacute} \NC \type{ü} \NC\FR + \NC é \NC \type{\'e} \NC \type{\egrave} \NC \type{é} \NC\MR + \NC â \NC \type{\^a} \NC \type{\acircumflex} \NC \type{â} \NC\MR + \NC ä \NC \type{\"a} \NC \type{\aacute} \NC \type{ä} \NC\MR + \NC à \NC \type{\`a} \NC \type{\agrave} \NC \type{à} \NC\MR + \NC å \NC \type{\aa} \NC \type{\aring} \NC \type{å} \NC\MR + \NC ç \NC \type{\c{c}} \NC \type{\ccedilla} \NC \type{ç} \NC\MR + \NC ï \NC \type{\"{\i}} \NC \type{\idiaeresis} \NC \type{ï} \NC\MR + \NC î \NC \type{\^{\i}} \NC \type{\icircumflex} \NC \type{î} \NC\MR + \NC Ä \NC \type{\"A} \NC \type{\Adiaeresis} \NC \type{Ä} \NC\MR + \NC Å \NC \type{\AA} \NC \type{\Aring} \NC \type{Å} \NC\MR + \NC É \NC \type{\'E} \NC \type{\Egrave} \NC \type{É} \NC\MR + \NC æ \NC \type{\ae} \NC \type{\aeligature} \NC \type{æ} \NC\MR + \NC Æ \NC \type{\AE} \NC \type{\AEligature} \NC \type{Æ} \NC\MR + \NC ÿ \NC \type{\"y} \NC \type{\ydiaeresis} \NC \type{ÿ} \NC\LR + \HL + \stoptable} + +The character you want to display should be in the font. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-descriptions.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-descriptions.tex new file mode 100644 index 000000000..01c8fb608 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-descriptions.tex @@ -0,0 +1,94 @@ +\startcomponent ma-cb-en-descriptions + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Definitions] + +\index{definition} + +\Command{\tex{definedescription}} +\Command{\tex{setupdescriptions}} + +If you want to display notions, concepts and ideas in a consistent manner you can +use: + +\shortsetup{definedescription} + +For example: + +\startbuffer +\definedescription + [concept] + [alternative=serried,headstyle=bold,width=broad] + +\concept{Hasselter juffer} A sort of biscuit made of puff pastry and +covered with sugar. It tastes very sweet. \par +\stopbuffer + +\typebuffer + +It would look like this: + +\getbuffer + +But you can also choose other layouts: + +\startbuffer +\definedescription + [concept] + [alternative=top, + inbetween={\blank[none]}, + headstyle=bold, + width=broad, + style=slanted] + +\concept{Hasselter bitter} A very strong alcoholic drink (up to 40\%) +mixed with herbs to give it a special taste. It is sold in a stone +flask and it should be served {\em ijskoud} (as cold as ice). \par + +\definedescription + [concept] + [alternative=inmargin,headstyle=bold,width=broad] + +\concept{Euifeest} A harvest home to celebrate the end of a period of +hard work. The festivities take place in the last week of August. \par +\stopbuffer + +\start +\getbuffer +\stop + +If you want to avoid the \type{\par} or when you have more than one paragraph in +the definition you can use the \type{\start...\stop} construct. + +\startbuffer +\definedescription + [concept] + [alternative=right, + headstyle=bold, + width=broad] + +\startconcept{Euifeest} A harvest home to celebrate the end of a +period of hard work. +This event takes place at the end of August and lasts one week. The +city is completely illuminated and the streets are decorated. This +feast week ends with a {\em Braderie}. +\stopconcept +\stopbuffer + +\typebuffer + +This would become: + +\getbuffer + +Layout is set up within the second bracket pair of +\type{\definedescription[][]}. But you can also use: + +\shortsetup{setupdescriptions} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-document.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-document.tex new file mode 100644 index 000000000..94fdb7ea2 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-document.tex @@ -0,0 +1,117 @@ +\startcomponent ma-cb-en-document + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=How to create a textbook] + +\index{input file} + +Let's assume you want to create a simple textbook. It has some structure and +contains a title page, a few chapters, sections and sub sections. Of course there +is a table of contents. + +\CONTEXT\ can create such a document automatically if you offer the right input +by means of a file. So first you have to create an input file. An input file +consists of a name and an extension. You can choose any name you want but the +extension has to be \type{.tex}. If you create a file with the name +\type{mybook.tex} you will find no difficulties in running \CONTEXT. + +An \pagereference[inputfile] input file could look like this: + +\startbuffer +\starttext + +\startstandardmakeup + \midaligned{From Hasselt to America} + \midaligned{by} + \midaligned{J. Jonker and C. van Marle} +\stopstandardmakeup + +\placecombinedlist[content] + +\chapter{Introduction} + +... ties between Hasselt and America ... + +\chapter[rensselaer]{The Rensselaer family} + +\section{The first born} + +... was born in the year ... + +\section{The early years} + +... in those days Hasselt was ... + +\section{Living and workin in America} + +... life in America was ... + +\chapter[lansing]{The Lansing family} + +... the Lansing family was also ... + +\chapter[cuyler]{The Cuyler family} + +... much later Tydeman Cuyler ... + +\stoptext +\stopbuffer + +{\switchtobodyfont[9pt]\typebuffer} + +\CONTEXT\ expects a plain \ASCII\ input file. Of course you can use any +text|-|editor, as long as you save the file as standard \ASCII\ (also called txt +file) with the extension \type{.tex}. Note that spaces in the filename are +not allowed. + +The input file contains the text you want to typeset and the \CONTEXT\ commands. +A \CONTEXT\ command begins with a backslash~\tex{}. With the command +\type{\starttext} you indicate the beginning of your text. + +A command is sometimes followed by an argument which is enclosed by curly braces +\type{{}}. The command \type{\chapter[cuyler]{The Cuyler family}} that you see in +the example will have its effect on {\em The Cuyler family}. Its actions will +have effect on the design, typography and structure. The actions may be: + +\startitemize[n,packed] +\item start a new page +\item increase chapter number by one +\item place chapter number in front of chapter title +\item reserve some vertical space +\item use a big font +\item put chapter title (and page number) in the table of contents +\stopitemize + +Other actions concerning running heads, number resetting and interactivity are +disregarded at this moment. + +Sometimes you will see two brackets (\type{[]}) directly after the command. These +brackets are used to feed specific options to the command. Further on in this +manual you will get more information on these brackets. + +The commands in your input file can have the following appearance: + +\starttabulate[|||] +\HL +\NC \bf Appearance of command \NC \bf Example \NC\NR +\HL +\NC \type{\startcommand ... \stopcommand} \NC \type{\starttext ... \stoptext} \NC\NR +\NC \type{\startcommand[] ... \stopcommand} \NC \type{\startitemize[packed] ... \stopitemize} \NC\NR +\NC \type{\command} \NC \type{\item} \NC\NR +\NC \type{\command[]} \NC \type{\in[cuyler]} \NC\NR +\NC \type{\command{}[]} \NC \type{\at{page}[cuyler]} \NC\NR +\NC \type{\command{}} \NC \type{\index{America}} \NC\NR +\NC \type{\command[]{}} \NC \type{\chapter[cuyler]{The Cuyler family}} \NC\NR +\HL +\stoptabulate + +If you have \CONTEXT\ process the above example file, you would obtain a very +simple document with a title page, a few numbered chapters and section headers +and a table of content (because of \type{\placecombinedlist[content]}). + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-enumerations.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-enumerations.tex new file mode 100644 index 000000000..6f2fa5f22 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-enumerations.tex @@ -0,0 +1,106 @@ +\startcomponent ma-cb-en-enumerations + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Numbered definitions] + +\index{numbered definition} + +\Command{\tex{defineenumeration}} +\Command{\tex{setupenumerations}} + +With \type{\defineenumeration} you can number text elements like remarks or +questions. If you want to make numbered remarks in your document you use: + +\shortsetup{defineenumeration} + +For example: + +\startbuffer[a] +\defineenumeration + [remark] + [alternative=top, + text=Remark, + inbetween={\blank[none]}, + after=\blank] +\stopbuffer + +\typebuffer[a] + +Now the new commands \type{\remark}, \type{\subremark}, \type{\resetremark} and +\type{\nextremark} are available and you can type remarks like this: + +\startbuffer[b] +\remark In the early medieval times Hasselt was a place of +pilgrimage. The {\em Heilige Stede} (Holy Place) was torn down during +the Reformation. In 1930, after 300 years, the {\em Heilige Stede} was +reopened. + +\subremark Nowadays the {\em Heilige Stede} is closed again but once +a year an open air service is held on the same spot. \par +\stopbuffer + +\typebuffer[b] + +This becomes: + +\start +\getbuffer[a]\getbuffer[b] +\stop + +You can reset numbering with \type{\resetremark} or \type{\resetsubremark} or +increment a number with \type{\nextremark} or \type{\nextsubremark}. This is +normally done automatically per chapter, section or whatever. + +You can set up the layout of \type{\defineenumeration} with: + +\shortsetup{setupenumerations} + +You can also vary the layout of \type{remark} and \type{subremark} in the example +above with: + +\starttyping +\setupenumeration[remark][headstyle=bold] +\setupenumeration[subremark][headstyle=slanted] +\stoptyping + +If a number becomes obsolete you can type: + +\starttyping +\remark[-] +\stoptyping + +If the \type{remark} contains several paragraphs you should use the command +pair \type{\start ... \stopremark} that becomes available after defining +\type{remark} with \type{\defineenumeration[remark]}. + +\startbuffer[c] +\setupenumeration + [remark] + [alternative=hanging, + width=broad] + +\startremark +In the early medieval times Hasselt was a place of pilgrimage. The +{\em Heilige Stede} (Holy Place) was torn down during the +Reformation. + +After 300 years in 1930 the {\em Heilige Stede} was reopened. +Nowadays the {\em Heilige Stede} is closed again but once a year an +open air service is held on the same spot. +\stopremark +\stopbuffer + +\typebuffer[c] + +So the example above would look like this: + +\start +\getbuffer[a]\getbuffer[c] \par +\stop + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-errors.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-errors.tex new file mode 100644 index 000000000..229cb66bc --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-errors.tex @@ -0,0 +1,79 @@ +\startcomponent ma-cb-en-errors + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=trouble,title=Problems during processing] + +\index{errors} +\index{problems} + +If processing is not succesful ---for example because you typed \type{\stptext} +instead of \type{\stoptext}--- \CONTEXT\ produces a \type{ ? } on your screen +and tells you it has just processed an error. It will give you some basic +information on the type of error and the line number where the error becomes +effective. + +At the instant of \type{ ? } you can type: + +\starttabulate[|||] +\NC \type{H} \NC for help information on your error \NC\NR +\NC \type{I} \NC for inserting the correct \CONTEXT\ command \NC\NR +\NC \type{Q} \NC for quiting and entering batch mode \NC\NR +\NC \type{X} \NC for exiting the running mode \NC\NR +\NC \Enter \NC for ignoring the error \NC\NR +\stoptabulate + +Most of the time you will type \Enter\ and processing will continue. Then you can +edit the input file and fix the error. + +Some errors will produce a~\type{ * } on your screen and processing will stop. +This error is due to a fatal error in your input file. You can't ignore this +error and the only option you have is to type \type{\stop} or {\sc Ctrl}~Z. The +program will be halted and you can fix the error in your text editor. + +\startframedtext[width=\hsize] +A well known error is: + +\starttyping +! I can't write on file 'myfile.pdf'. +Please type another filename for output: +\stoptyping + +This error is due to the fact that the file \type{myfile.pdf} is stil open +in \READER. + +\blank + +The best way to proceed is: + +\startitemize[packed] +\item close the file in \READER +\item type \Enter\ at the console +\stopitemize +\stopframedtext + +Sometimes the error messages are very obscure. Finding the location of the error +in an extensive document can then be a tedious job. You could try to isolate +the error: + +\startitemize[packed] +\item open the file in your text editor +\item save a copy of your file (to be on the safe side) +\item isolate the error + \startitemize[n,packed] + \item place a \type{\stoptext} command higher up in your text + \item process the file + \item repeat step 1 and 2 until the file processes correctly + \stopitemize +\item study the content that produces the error +\item fix the error +\item place the \type{\stoptext} command after the corrected error +\item process your file +\item etc. +\stopitemize + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-figures.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-figures.tex new file mode 100644 index 000000000..90f249359 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-figures.tex @@ -0,0 +1,258 @@ +\startcomponent ma-cb-en-figures + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=figures,title=Figures] + +\index{figure} +\seeindex{picture}{figure} +\index{floating blocks} + +\Command{\tex{placefigure}} +\Command{\tex{startfiguretext}} +\Command{\tex{setupfigures}} +\Command{\tex{startcombination}} +\Command{\tex{setupfloats}} +\Command{\tex{setupcaptions}} +\Command{\tex{externalfigure}} + +Images can be placed in your document with the command \type{\externalfigure}. + +\startbuffer +\externalfigure + [cow.pdf] + [width=.1\textwidth, + frame=on, + framecolor=gray, + frameoffset=3pt, + rulethickness=3pt, + framecorner=round] +\stopbuffer + +\typebuffer + +Such an image will be placed on the location where you defined it \space \getbuffer +\space and can have some strange effects on the surrounding white space. By the way, +the cow image is always available for \CONTEXT\ users which is very convenient when +you are testing the figure related commands. + +You can use the command \type{\placefigure} to influence the positioning of +images in your document. + +\startbuffer +\placefigure + [][fig:church] + {Stephanus Church.} + {\externalfigure[ma-cb-24][width=.4\textwidth]} +\stopbuffer + +\typebuffer + +After processing this will come out as \in{figure}[fig:church] at the first +available location. + +\getbuffer + +The command \type{\placefigure} handles numbering and vertical spacing before and +after your figure. Furthermore this command initializes a float mechanism, which +means that \CONTEXT\ looks whether there is enough space for your figure on the +page. If not, the figure will be placed at another location and the text carries +on, while the figure floats in your document until the optimal location is found. +You can influence this mechanism within the first bracket +pair. + +The command \type{\placefigure} is a predefined example of: + +\shortsetup{placefloat} + +A number of basic options is described in \in{table}[tab:placefigure]. + +\placetable + [here] + [tab:placefigure] + {Options in \type{\placefigure}.} +\starttable[|l|l|] +\HL +\NC \bf Option \NC \bf Meaning \NC\SR +\HL +\NC here \NC put figure at this location if possible \NC\FR +\NC force \NC force figure placement here \NC\MR +\NC page \NC put figure on its own page \NC\MR +\NC top \NC put the figure at the top of the page \NC\MR +\NC bottom \NC put the figure at the botom of the page \NC\MR +\NC left \NC place figure at the left margin \NC\MR +\NC right \NC place figure at the right margin \NC\MR +\NC margin \NC place figure in the margin \NC\MR +\NC none \NC set no caption \NC\LR +\HL +\stoptable + +The second bracket pair is used for cross-referencing. You can refer to this +particular figure by typing: + +\starttyping +\in{figure}[fig:church] +\stoptyping + +The first brace pair is used for the caption. You can type any text you want. The +figure labels are set up with \type{\setupcaptions} and the numbering is (re)set +by \type{\setupnumbering} (see \in{paragraph}[floatingblocks]). + +The second brace pair is used for defining the figure and addressing the file +names of external figures. + +In the next example you see how \inframed{Hasselt} is defined within +the last brace pair to show you the function of \type{\placefigure{}{}}. + +\startbuffer +\placefigure + {The boundaries of Hasselt.} + {\framed{\tfd Hasselt}} +\stopbuffer + +\typebuffer + +This will produce: + +\getbuffer + +However, your images are often created using programs like Illustrator and photos +are --- after scanning --- improved in packages like PhotoShop. Then the images +are available as files. \CONTEXT\ supports image file types like \type {JPG}, +\type {PNG} and (pages from) \type {PDF} files as well as \METAPOST\ output +(\type {MPS} files). Users normally can trust \CONTEXT\ to find the best possible +file type. + +In \in{figure}[fig:canals] you see a photo and a graphic combined into one +figure. + +\startbuffer +\placefigure + [here,force] + [fig:canals] + {The Hasselt Canals.} + {\startcombination[2*1] + {\externalfigure[ma-cb-03][width=.4\textwidth]}{a bitmap picture} + {\externalfigure[ma-cb-00][width=.4\textwidth]}{a vector graphic} + \stopcombination} +\stopbuffer + +\getbuffer + +You can produce this figure by typing something like: + +\typebuffer + +In this figure two pictures are combined with: + +\shortsetup{startcombination} + +The \type{\start ...\stopcombination} pair is used for +combining two pictures in one figure. You can type the number of pictures within +the bracket pair. If you want to display one picture below the other you would +have typed \type{[1*2]}. You can imagine what happens when you combine 6~pictures +as \type{[3*2]} (\type{[rows*columns]}). + +The examples shown above are enough for creating illustrated documents. Sometimes +however you want a more integrated layout of the picture and the text. For that +purpose you can use \type{\start ...\stopfiguretext} command pair. + +\startbuffer +\startfiguretext + [left,none] + [fig:citizens] + {} + {\externalfigure[ma-cb-18][width=.5\makeupwidth]} + Hasselt has always had a varying number of citizens due to + economic events. For example the Dedemsvaart was dug around + 1810. This canal runs through Hasselt and therefore trade + flourished. This led to a population growth of almost 40\% + within 10~years. Nowadays the Dedemsvaart has no commercial + value anymore and the canals have become a tourist + attraction. But reminders of these prosperous times can be + found everywhere. +\stopfiguretext +\stopbuffer + +The effect of: + +\typebuffer + +is shown in the figure below. + +\start +\setuptolerance[verytolerant] +\getbuffer +\stop + + +\startbuffer[marginpicture] +\inmargin + {\externalfigure + [ma-cb-23] + [width=.7\marginwidth]} +\stopbuffer + +As you have seen you in the examples above you can summon a figure with the +command: + +\shortsetup{externalfigure} + +The command \type{\externalfigure} has two bracket pairs. The first is used for +the exact file name without extension, the second for file formats and +dimensions. It is not difficult to guess what happens if you +type:\getbuffer[marginpicture] + +\typebuffer[marginpicture] + +You can set up the layout of figures with: + +\shortsetup{setupfloats} + +You can set up the numbering and the labels with: + +\shortsetup{setupcaptions} + +\startbuffer[figuresetups] +\setupfloat + [figure] + [default=right, + spacebefore=none] + +\setupcaptions + [location=bottom, + style=boldslanted] +\stopbuffer + +\startbuffer[figuredefinition] +\placefigure + {A characteristic view on Hasselt.} + {\externalfigure[ma-cb-12][width=6cm]} +\stopbuffer + +\start +\getbuffer[figuresetups] +\getbuffer[figuredefinition] +\stop + +These commands are typed in the set up area of your input file and have a global +effect on all floating blocks. + +\typebuffer[figuresetups,figuredefinition] + +For figure management there are commands like \crlf +\type{\setupexternalfigure}. + +Please refer to the \goto {\CONTEXTWIKI} [ +url(http://wiki.contextgarden.net/Command/defineexternalfigure) ] for practical +applications of these commands. + +If you want to work with a \XML\ based figure database please see the \goto +{Figures} [ url (manual:figures) ] +manual. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-fonts.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-fonts.tex new file mode 100644 index 000000000..029386ec1 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-fonts.tex @@ -0,0 +1,299 @@ +\startcomponent ma-cb-en-fonts + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Fonts and font switches] + +\startsection[title=Introduction] + +\index{Computer Modern Roman} +\index{Lucida Bright} +\index{AMS} + +The default font in \CONTEXT\ is the {\em Computer Modern Roman} (\type{cmr}). +In \CONTEXT\ the following fonts are available. + +\startplacetable[reference=tab:fonts in context,title={Fonts in \CONTEXT.}] +\starttable[|l|l|l|] +\HL +\NC \bf Name \NC \bf Logical name \NC \bf Also known as \NC\MR +\HL +\NC Computer Modern Roman \NC cmr \NC Computer Modern Roman \NC\FR +\NC Termes \NC termes \NC Times New Roman \NC\MR +\NC Adventor \NC adventor \NC Avant Garde \NC\MR +\NC Bonum \NC bonum \NC Bookman \NC\MR +\NC Chorus \NC chorus \NC Zapf Chancery \NC\MR +\NC Cursor \NC cursor \NC Courier \NC\MR +\NC Heros \NC heros \NC Helvetica \NC\MR +\NC Pagella \NC pagella \NC Palatino \NC\MR +\NC Schola \NC schola \NC Century Schoolbook \NC\MR +\NC Dejavu \NC dejavu \NC \NC\MR +\NC Iwona \NC iwona \NC \NC\MR +\NC Gentium \NC gentium \NC \NC\MR +\NC Cambria \NC cambria \NC \NC\MR +\NC Antykwa \NC antykwa \NC \NC\MR +\NC Utopia \NC utopia \NC \NC\MR +\NC LucidaBright \NC lucidanova \NC \NC\LR +\HL +\stoptable +\stopplacetable + +% in map: tex-context\tex\texmf\fonts + +For further reading we refer to the \goto {\em Fonts in \CONTEXT} +[ url (manual:fonts) ] manual where you can find information on how to install +your own font. + +\stopsection + +\startsection[title=Fontstyle and size] + +\index{font+style} +\index{font+size} + +\Command{\tex{setupbodyfont}} +\Command{\tex{switchtobodyfont}} + +You can select the font family, style and size for a document with: + +\shortsetup{setupbodyfont} + +If you typed \type{\setupbodyfont[chorus,9pt]} {\switchtobodyfont[chorus,9pt] in +the setup area of the input file your text would look something like this.} + +For changes in mid-document and on section level you should use: + +\shortsetup{switchtobodyfont} + +\startbuffer +On November 10th (one day before Saint Martinsday) the youth of +Hasselt go from door to door to sing a special song and they +accompany themselves on a {\em foekepot}. They won't leave +before you give them some money or sweets. The song goes like this: + +\startnarrower +\switchtobodyfont[heros,small] +\startlines +Foekepotterij, foekepotterij, +Geef mij een centje dan ga'k voorbij. +Geef mij een alfje dan blijf ik staan, +'k Zal nog liever naar m'n arrenmoeder gaan. +Hier woont zo'n rieke man, die zo vulle gèven kan. +Gèf wat, old wat, gèf die arme stumpers wat, +'k Eb zo lange met de foekepot elopen. +'k Eb gien geld om brood te kopen. +Foekepotterij, foekepotterij, +Geef mij een centje dan ga'k voorbij. +\stoplines +\stopnarrower +\stopbuffer + +\typebuffer + +Notice that \type{\start...\stopnarrower} is also used as a begin and end of the +fontswitch. The function of \type{\start...\stoplines} in this example is +obvious. + +\start +\getbuffer +\stop + +If you want an overview of the available font family you can type: + +\startbuffer +\showbodyfont[pagella] +\stopbuffer + +\typebuffer + +\getbuffer + +\stopsection + +\startsection[title=Style and size switch in commands] + +In a number of commands one of the parameters is \type{style} to indicate the +desired typestyle. For example: + +\startbuffer +\setuphead[chapter][style=\tfd] +\stopbuffer + +\typebuffer + +In this case the character size for chapters is indicated with a command +\type{\tfd}. But instead of a command you could use the predefined options that +are related to the actual typeface: + +\startbuffer +normal bold slanted boldslanted type mediaeval +small smallbold smallslanted smallboldslanted smalltype +capital cap +\stopbuffer + +\typebuffer + +\stopsection + +\startsection[title=Local font style and size] + +\Command{\tex{rm}} +\Command{\tex{ss}} +\Command{\tex{tt}} +\Command{\tex{sl}} +\Command{\tex{bf}} +\Command{\tex{tfa}} +\Command{\tex{tfb}} +\Command{\tex{tfc}} +\Command{\tex{tfd}} + +In the running text (local) you can change the {\em typestyle} into roman, sans +serif and teletype with \type{\rm}, \type{\ss} and \type{\tt}. + +You can change the {\em typeface} like italic and boldface with \type{\sl} and +\type{\bf}. + +The {\em typesize} is changed with \type{\switchtobodyfont}. + +The actual style is indicated with \type{\tf}. If you want to change into a +somewhat greater size you can type \type{\tfa}, \type{\tfb}, \type{\tfc} and +\type{\tfd}. An addition of \type{a}, \type{b}, \type{c} and \type{d} to +\type{\sl}, \type{\it} and \type{\bf} is also allowed. + +\startbuffer +{\tfc Mintage} + +In the period from {\tt 1404} till {\tt 1585} Hasselt had its own +{\sl right of coinage}. This right was challenged by other cities, +but the {\switchtobodyfont[7pt] bishops of Utrecht} did not honour +these {\slb protests}. +\stopbuffer + +\typebuffer + +The curly braces indicate begin and end of style or size switches. + +\getbuffer + +\stopsection + +\startsection[title=Redefining fontsize] + +\index{fontsize} + +\Command{\tex{definebodyfont}} + +For special purposes you can define your own size of the bodyfont. + +\shortsetup{definebodyfont} + +A definition could look like this: + +\startbuffer +\definebodyfont[10pt][rm][tfe=Regular at 36pt] + +{\tfe Hasselt!} +\stopbuffer + +\typebuffer + +Now \type{\tfe} will produce 36pt characters saying: +{\hbox{\getbuffer}} + +\stopsection + +\startsection[title=Small caps] + +\index{small caps} + +\Command{\tex{cap}} + +Abbreviations like \PDF\ (\infull{PDF}) are printed in pseudo small caps. A small +capital is somewhat smaller than the capital of the actual typeface. Pseudo small +caps are produced with: + +\shortsetup{cap} + +If you compare \type{\cap{hasselt}} and \type{\sc hasselt}: \cap{hasselt} and +{\sc hasselt} you can see the difference. The command \type{\sc} shows the real +small caps. The reason for using pseudo small caps instead of real small caps is +just a matter of taste. + +\stopsection + +\startsection[title=Emphasized] + +\index{emphasized} + +\Command{\tex{em}} + +To emphasize words consistently throughout your document +you use: + +\starttyping +\em +\stoptyping + +Empasized words appear in a slanted style. + +\startbuffer +If you walk through Hasselt you should {\bf \em watch out} for +{\em Amsterdammers}. An {\em Amsterdammer} is {\bf \em not} a +person from Amsterdam but a little stone pillar used to separate +sidewalk and road. A pedestrian should be protected by these +{\em Amsterdammers} against cars but more often people get hurt +from tripping over them. +\stopbuffer + +\typebuffer + +This becomes: + +\getbuffer + +{\em An emphasize within an emphasize is {\em normal} again +and a boldface emphasize looks like {\bf this or \em this}}. + +\stopsection + +\startsection[title=Teletype / verbatim] + +\index{type} +\index{verbatim} + +\Command{\tex{starttyping}} +\Command{\tex{type}} +\Command{\tex{setuptyping}} +\Command{\tex{setuptype}} + +If you want to display typed text and want to keep your line breaking exactly as +it is you use: + +\shortsetup{starttyping} + +In the text you can use: + +\shortsetup{type} + +The curly braces enclose the text you want in teletype. You have to be careful +with \type{\type} because the line breaking mechanism does not work anymore. + +You can set up the 'typing' with: + +\shortsetup{setuptyping} +\shortsetup{setuptype} + +\stopsection + +\startsection[title=Encodings] + +In \CONTEXT\ \MKIV\ font ecoding is no issue (anymore). + +\stopsection + +\stopchapter + +\stopcomponent + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-footnotes.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-footnotes.tex new file mode 100644 index 000000000..5eeade383 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-footnotes.tex @@ -0,0 +1,99 @@ +\startcomponent ma-cb-en-footnotes + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Footnotes] + +\index{footnote} + +\Command{\tex{footnote}} +\Command{\tex{setupfootnotes}} + +If you want to annotate your text you can use \type{\footnote}. The command looks +like this: + +\shortsetup{footnote} + +The bracket pair is optional and contains a logical name. The curly braces +contain the text you want to display at the foot of the page. + +The same footnote number can be called with its logical name. + +\shortsetup{note} + +If you have typed this text: + +\startbuffer +The Hanse was a late medieval commercial alliance of towns in the +regions of the North and the Baltic Sea. The association was formed +for the furtherance and protection of the commerce of its +members.\footnote[war]{This was the source of jealousy and fear among +other towns that caused a number of wars.} In the Hanse period there +was a lively trade in all sorts of articles such as wood, wool, +metal, cloth, salt, wine and beer.\note[war] The prosperous trade +caused an enormous growth of welfare in the Hanseatic +towns.\footnote{Hasselt is one of these towns.} +\stopbuffer + +\typebuffer + +It would look like this: + +\getbuffer + +The footnote numbering is done automatically. The command \type{\setupfootnotes} +enables you to influence the display of footnotes: + +\shortsetup{setupfootnotes} + +Footnotes can be set at the bottom of a page but also at other locations, like +the end of a chapter. This is done with the command: + +\shortsetup{placefootnotes} + +The footnotes will be placed at the end of your document with +\type{\setupfootnotes[location=text]} in combination with \type{\placefootnotes} +at the desired location. + +You can also couple footnotes to a table. In that case we speak of local +footnotes. The commands are: + +\shortsetup{startlocalfootnotes} + +\shortsetup{placelocalfootnotes} + +An example illustrates the use of local footnotes: + +\startbuffer + +\placetable[][productivity] + {Decline of Hasselt's productivity.\footnote{Source: {\em Uit + de geschiedenis van Hasselt.}}} + {\startlocalfootnotes + \starttable[|l|c|c|c|c|] + \HL + \NC + \NC Ovens + \NC Blacksmiths + \NC Breweries + \NC Tile works\footnote{The factories that produced roof tiles.} \NC\SR + \HL + \NC 1682 \NC 15 \NC 9 \NC 3 \NC 2 \NC\FR + \NC 1752 \NC ~6 \NC 4 \NC 0 \NC 0 \NC\LR + \HL + \NC \use5 \JustLeft{\placelocalfootnotes} \NC\FR + \stoptable + \stoplocalfootnotes} +\stopbuffer + +\typebuffer + +This will result in \in{table}[productivity] with a local footnote. The footnote +in the caption will appear at the bottom of the page. +\getbuffer + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-framedtexts.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-framedtexts.tex new file mode 100644 index 000000000..2f422344b --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-framedtexts.tex @@ -0,0 +1,58 @@ +\startcomponent ma-cb-en-framedtexts + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Outlined paragraphs] + +\index{outline+paragraph} + +\Command{\tex{startframedtext}} +\Command{\tex{setupframedtext}} + +Complete paragraphs can be outlined with: + +\shortsetup{startframedtext} + +\startbuffer +\definefloat[intermezzo] +\setupframedtexts + [width=.8\makeupwidth, + background=color, + backgroundcolor=gray, + corner=round, + framecolor=blue, + rulethickness=2pt] + +\placeintermezzo[here][block:bridge]{An intermezzo.} +\startframedtext + It was essential for Hasselt to have a bridge across the Zwarte + Water river. The bishop of Utrecht gave Hasselt his consent in + 1486. + \blank + Other cities in the neighbourhood of Hasselt were afraid of the + toll money to be paid when crossing this bridge so they + prevented the construction for many years. +\stopframedtext +\stopbuffer + +Let's give an example: + +\typebuffer + +This example also illustrates the command \type{\definefloat}. You can find more +information on this command in \in{paragraph}[floatingblocks]. The \type{\blank} +is necessary to enforce a blank line. + +\start +\getbuffer +\stop + +The outlining can be set up with: + +\shortsetup{setupframedtexts} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-frames.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-frames.tex new file mode 100644 index 000000000..bbdb6a61c --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-frames.tex @@ -0,0 +1,144 @@ +\startcomponent ma-cb-en-frames + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Outlined text] + +\index{outline+text} + +\Command{\tex{framed}} +\Command{\tex{setupframed}} +\Command{\tex{inframed}} + +You can \inframed{outline} a text with \type{\framed}. The +command looks like this: + +\shortsetup{framed} + +The bracket pair is optional and contains the set up parameters. The curly braces +enclose the text. To be honest, the outlined text in the first paragraph was done +with \type{\inframed}. This command takes care of the interline spacing. + +Some other examples of \type{\framed} and its set up parameters are shown below. + +\startbuffer[a] +\framed + [height=fit, + width=.5\textwidth] + {Hasselt} +\stopbuffer + +\placefigure[right,none][]{}{\externalfigure[a][type=buffer]} +\typebuffer[a] + +\startbuffer[b] +\framed + [height=3em, + width=.5\textwidth] + {Hasselt now has more space} +\stopbuffer + +\placefigure[right,none][]{}{\externalfigure[b][type=buffer]} +\typebuffer[b] + +\startbuffer[d] +\framed + [height=3em, + width=.5\textwidth, + foregroundcolor=red, + framecolor=blue] + {Hasselt now has some color} +\stopbuffer + +\placefigure[right,none][]{}{\externalfigure[d][type=buffer]} +\typebuffer[d] + +\startbuffer[e] +\framed + [height=3em, + width=.5\textwidth, + foregroundcolor=red, + framecolor=blue, + rulethickness=2pt] + {Hasselt now has more frame} +\stopbuffer + +\placefigure[right,none][]{}{\externalfigure[e][type=buffer]} +\typebuffer[e] + +\startbuffer[f] +\framed + [height=3em, + width=.5\textwidth, + foregroundcolor=red, + framecolor=blue, + rulethickness=2pt, + background=color, + backgroundcolor=green] + {Hasselt now has a colorful background} +\stopbuffer + +\placefigure[right,none][]{}{\externalfigure[f][type=buffer]} +\typebuffer[f] + +\startbuffer[g] +\framed + [height=3em, + width=.5\textwidth, + foregroundcolor=red, + framecolor=blue, + rulethickness=2pt, + background=color, + backgroundcolor=green, + foregroundstyle=bold] + {Hasselt now has another style} +\stopbuffer + +\placefigure[right,none][]{}{\externalfigure[g][type=buffer]} +\typebuffer[g] + +\startbuffer[needed-for-h] +\definecolor[a][black] +\definecolor[b][white] + +\startuniqueMPgraphic{LinearShade} + fill OverlayBox + withshademethod "linear" withcolor \MPcolor{a} shadedinto \MPcolor{b} ; +\stopuniqueMPgraphic + +\defineoverlay + [linear shade] + [\uniqueMPgraphic{LinearShade}] +\stopbuffer + +\getbuffer[needed-for-h] + +\startbuffer[h] +\framed + [height=3em, + width=.5\textwidth, + foregroundcolor=red, + framecolor=blue, + rulethickness=2pt, + background=linear shade, + foregroundstyle=bold] + {Hasselt now has a little shade} +\stopbuffer + +\placefigure[right,none][]{}{\externalfigure[h][type=buffer]} +\typebuffer[h] + +The shady background was defined with: + +\typebuffer[needed-for-h] + +The \type{\framed} command is very sophisticated and is used in many macros. +The command to set up frames is: + +\shortsetup{setupframed} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-gettingstarted.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-gettingstarted.tex new file mode 100644 index 000000000..6314aeec5 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-gettingstarted.tex @@ -0,0 +1,46 @@ +\startcomponent ma-cb-en-gettingstarted + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=How to process a file] + +\index{input file+processing} +\index[pdffile]{\type{pdf}--file} + +In this chapter we assume that you have installed and initiated \CONTEXT\ \MKIV\ +correctly so that you can run it from the commandline in your working directory. +You can find the \CONTEXT\ installation procedure on the \goto {\CONTEXTWIKI} +[ url (http://wiki.contextgarden.net/ConTeXt_Standalone#Windows) ]. + +If you want to process a \CONTEXT\ input file, you should type at the command line +prompt: + +\starttyping +context myfile.tex +\stoptyping + +the extension \type{.tex} is not needed. See \in{appendices}[contextcommand] and +\in[runtimefiles] for more information on the \type{context} command. + +After pressing \Enter\ processing will be started. \CONTEXT\ will show processing +information on your screen. During the processing of your input file \CONTEXT\ +will also inform you of what it is doing with your document. For example it will +show page numbers and information about processing steps. Further more it gives +warnings. These are of a typographical order and tells you when line breaking is +not successful. All information on processing is stored in a \type{log} file that +can be used for reviewing warnings and errors and the respective line numbers +where they occur in your file. + +If processing is succesful the command line prompt will return and \CONTEXT\ will +produce the file \type{myfile.pdf}. The abbreviation \PDF\ stands for Portable +Document Format. This is a platform independent format for printing and viewing +with \READER. + +When you use a configurable text editor you can also run \CONTEXT\ from that editor. +More information on that topic can be found \in{appendix}[texteditor]. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-headers.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-headers.tex new file mode 100644 index 000000000..d51403d5d --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-headers.tex @@ -0,0 +1,53 @@ +\startcomponent ma-cb-en-headers + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Page headers and footers] + +\index{page header} +\index{page footer} + +\Command{\tex{setupfootertexts}} +\Command{\tex{setupheadertexts}} +\Command{\tex{setupheader}} +\Command{\tex{setupfooter}} +\Command{\tex{noheaderandfooterlines}} + +In some cases you want to give your document a page header and footer. The +commands to do this are: + +\shortsetup{setupfootertexts} +\shortsetup{setupheadertexts} + +The first bracket pair is used for the location of the footer or header +(\type{text}, \type{edge} etc). Footer and header are placed within the second +and third bracket pairs. In a double sided document a fourth and fifth bracket +pair is used for footer and header on the left-hand side page and the right-hand +side page. In most cases you can omit these last two bracket pairs. + +\startbuffer +\setupfootertexts[Manual][section] +\stopbuffer + +\typebuffer + +In this case the text {\em Manual} will appear in the left-hand side corner and +the title of the actual section on the right-hand side of the page. This footer +will change with the beginning of a new section. + +You can set up the layout of the header and footer with: + +\shortsetup{setupheader} +\shortsetup{setupfooter} + +If you want to leave out the page header and footer you can type: + +\starttyping +\noheaderandfooterlines +\stoptyping + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-heads.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-heads.tex new file mode 100644 index 000000000..aa7e7b161 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-heads.tex @@ -0,0 +1,135 @@ +\startcomponent ma-cb-en-heads + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=heads,title=Heads] + +\index{headers} + +\Command{\tex{chapter}} +\Command{\tex{paragraph}} +\Command{\tex{subparagraph}} +\Command{\tex{title}} +\Command{\tex{subject}} +\Command{\tex{subsubject}} +\Command{\tex{setuphead}} +\Command{\tex{setupheads}} + +The structure of a document is determined by its chapter and section titles. +These titles are created with the commands shown in \in{table}[tab:headers]: + +\placetable[here][tab:headers]{Headers.} + {\starttable[|l|l|] + \HL + \NC \bf Numbered header \NC \bf Unnumbered header \NC\SR + \HL + \NC \type{\chapter} \NC \type{\title} \NC\FR + \NC \type{\section} \NC \type{\subject} \NC\MR + \NC \type{\subsection} \NC \type{\subsubject} \NC\MR + \NC \type{\subsubsection} \NC \type{\subsubsubject} \NC\MR + \NC \unknown \NC \unknown \NC\LR + \HL + \stoptable} + +\shortsetup{chapter} +\shortsetup{section} +\shortsetup{subsection} +\shortsetup{title} +\shortsetup{subject} +\shortsetup{subsubject} + +These commands will produce a numbered or unnumbered title in a predefined +fontsize and fonttype with some vertical spacing before and after the header. + +The title commands can take several arguments, like in: + +\starttyping +\title[hasselt by night]{Hasselt by night} +\stoptyping + +and + +\starttyping +\title{Hasselt by night} +\stoptyping + +The bracket pair is optional and used for internal references. If you want to +refer to this chapter you type for example \type{\at{page}[hasselt by night]}. + +For a more structured way to define chapters and sections you can use the more +preferred \type{\start ... \stop} construction. + +\placetable[here][tab:headers]{Structured headers.} + {\starttable[|l|l|] + \HL + \NC \bf Numbered header \NC \bf Un-numbered header \NC\SR + \HL + \NC \type{\start ... \stopchapter} \NC \type{\start ... \stoptitle} \NC\FR + \NC \type{\start ... \stopsection} \NC \type{\start ... \stopsubject} \NC\MR + \NC \type{\start ... \stopsubsection} \NC \type{\start ... \stopsubsubject} \NC\MR + \NC \type{\start ... \stopsubsubsection} \NC \type{\start ... \stopsubsubsubject} \NC\MR + \NC \unknown \NC \unknown \NC\LR + \HL + \stoptable} + +In that case the definition looks like this: + +\starttyping +\starttitle[reference="hasselt by night",title="Hasselt by night"} + ... +\stoptitle +\stoptyping + +Of course the chapter and section titles can be set to your own preferences and you can even +define your own sections. This is done with the \type{\setuphead} and +\type{\definehead} command. + +\shortsetup{definehead} + +\shortsetup{setuphead} + +\startbuffer +\definehead + [myhead] + [section] + +\setuphead + [myhead] + [numberstyle=bold, + textstyle=bold, + before=\hairline\blank, + after=\nowhitespace\hairline] + +\myhead[headlines]{Hasselt makes headlines} +\stopbuffer + +\typebuffer + +A new header \type{\myhead} is defined and it inherits the properties of +\type{\section}. It would look something like this: + +\getbuffer + +There is one other command you should know now, and that is \type{\setupheads}. +You can use this command to set up the numbering of the numbered chapters and +sections. If you type: + +\startbuffer +\setupheads + [alternative=inmargin, + separator=--] +\stopbuffer + +\typebuffer + +all numbers will appear in the margin. Section 1.1 would look like 1--1. + +Commands like \type{\setupheads} are typed in the set up area of your input file. + +\shortsetup{setupheads} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-interactivity.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-interactivity.tex new file mode 100644 index 000000000..64beb179d --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-interactivity.tex @@ -0,0 +1,310 @@ +\startcomponent ma-cb-en-interactivity + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Interactive mode in electronic documents,reference=interactivity] + +\startsection[title=Introduction] + +\index[reader]{\READER} + +Documents that are electronically available for consulting and displaying on a +computer screen are called interactive documents. + +Interaction means that you can click on active areas and jump to the indicated +locations. For example if you consult a register you can click on a (active) page +number and you will jump to the corresponding page. + +Interaction relates to: + +\startitemize[packed] +\item active chapter numbers in the table of content +\item active page numbers in registers +\item active page numbers, chapter numbers and figure numbers in internal + references to pages, chapters, figures etc. in the running text +\item active titles, page numbers, and chapter numbers in external references to + other interactive documents +\item active menus as navigation tools +\item references to webpages and programs +\stopitemize + +Interactivity depends on the program you use to view the interactive document. We +assume here that you will use \READER\ for viewing. + +\CONTEXT\ is a very powerful system for producing electronic or interactive \PDF\ +documents. However, only a few standard features are described in this chapter. As +the authors of this manual are planning to make all \CONTEXT\ related manuals +electronically (sources included) available, reverse engineering is one of the +options to become more acquainted with the possibilities of \CONTEXT. + +Good examples of interactive documents are \CONTEXT\ presentations (see \in{chapter}[presentations]). +For more complex interactive \PDF\ documents with forms you should read the +\goto {Widgets} [ url (manual:widget) ] +manual. + +\stopsection + +\startsection[title=Interactive mode] + +\index{interactive mode} + +\Command{\tex{setupinteraction}} + +The interactive mode is activated by: + +\shortsetup{setupinteraction} + +For example: + +\startbuffer +\setupinteraction + [state=start, + color=green, + style=bold] +\stopbuffer + +\typebuffer + +The hyper links are now generated automatically and the active words are +displayed in bold green. + +The interactive document is considerably bigger (in MB's) than its paper cousin +because hyperlinks consume space. You will also notice that processing time +becomes longer. Therefore it is advisable to de-activate the interactive mode as +long as your document is under construction. + +\stopsection + +\startsection[title=Interaction within a document] + +\index{interaction+internal} + +\Command{\tex{in}} +\Command{\tex{at}} +\Command{\tex{goto}} + +Earlier you have seen how to make a reference with \type{\in} and \type{\at}. You +may have wondered why you had to type \type{\in{chapter}[chap:introduction]}. In +the first place {\em chapter} and its corresponding chapter number will not be +separated at line breaking. In the second place the word {\em chapter} and its +number are typeset differently in the interactive mode. This gives the user a +larger clickable area. + +\stopsection + +\startsection[title=Interaction between documents] + +\index{interaction+external} + +\Command{\tex{from}} +\Command{\tex{useexternaldocument}} + +It is possible to link one document to another. First you have to state that you +want to refer to another document. This is done by: + +\shortsetup{useexternaldocument} + +The first bracket pair must contain a logical name of the document, the second +pair the file name of the other document and the third pair is used for the title +of the document. + +For refering to these other documents you can use: + +\shortsetup{from} + +The curly braces contain text and the brackets contain the reference. + +Look at the example below. + +\startbuffer +\useexternaldocument + [hia][hasseltbook][Festivities in Hasselt] + +Most tourist attractions are described in \from[hia].\crlf +A description of the \about[hia::euifeest] is found in \from[hia].\crlf +The eui||feest is described on \at{page}[hia::euifeest] in \from[hia].\crlf +See for more information \in{chapter}[hia::euifeest] in \from[hia]. +\stopbuffer + +\typebuffer + +The \type{\useexternaldocument} is usually typed in the set up area of your input +file. + +After processing your input file and the file \type{hasseltbook.tex}, +you will have two \PDF\ documents. The references come out like this: + +\start +\setupinteraction[state=start] +\getbuffer +\stop + +For more information on cross referencing look at +\goto {\CONTEXT\ Magazine 1103} [ url (thisway:crossrefs)]. + +\stopsection + +\startsection[title=Interaction with the world wide web] + +In interactive mode there is one other command that has little meaning in the +paper version. + +\shortsetup{goto} + +The curly braces contain text, the brackets contain a reference (logical name or a +location). + +\startbuffer +In \goto {Hasselt} [ url(http://www.stadindex.nl/plattegrond/hasselt) ] +all streets are build in a circular way. +\stopbuffer + +\typebuffer + +In the interactive document \goto{Hasselt}[ url(http://www.stadindex.nl/plattegrond/hasselt) ] +will be green and active. When you click the text you will jump to a map of Hasselt. + +For a consistent definition of the urls there is the command: + +\shortsetup{useURL} + +The adress is defined with: + +\startbuffer +\useURL + [loc:cityplan] % id + [http://www.stadindex.nl/plattegrond/hasselt] % adress + [] % document + [] % text +\stopbuffer + +\typebuffer + +The webadress is recalled by its logical name: +\type{\goto {Hasselt} [ url(loc:cityplan) ]}. + +It is of good practice to define and maintain the urls in a separate +file. + +\stopsection + +\startsection[title=Buttons] + +The command to define a button is: + +\shortsetup{button} + +The first bracket pair contains the setup keys, the curly brackets contain the +button text and the last bracket pair the destination. + +\startbuffer +\useexternalsoundtrack + [stranger][wayfaring_stranger.mp3] + +\button{Website Hasselt} [ url(http://www.hasselt.nl) ] +\button{MSWord Document} [ program(hasselt.doc) ] +\button{Sound Clip} [ StartSound{stranger} ] +\stopbuffer + +\typebuffer + +The first example results in a jump to a webpage, the second opens the file +\type{hasselt.doc} in \MSWORD\ and the third plays a tune. Note the use of the +\type{\useexternalsoundtrack} command. + +\stopsection + +\startsection[title=Menus] + +You can define a menu with: + +\shortsetup{startinteractionmenu} + +And set it up with: + +\shortsetup{setupinteractionmenu} + +The first bracket pair is used for its name and the second pair for setting up +the menu. + +A menu can be used in an interactive document. Below you can find a simple +example that you can copy to do some experimenting: + +\startbuffer +\setuppapersize + [S6][S6] + +\setuplayout + [header=0cm, topspace=.5cm, backspace=2cm, + margindistance=.5cm, margin=1cm, rightmargin=0cm, + edgedistance=.5cm, rightedge=2cm, width=fit, + height=13.8cm, footer=1cm, bottom=1cm] + +\setupinteraction + [state=start, menu=on] + +\setupinteractionmenu + [bottom] + [background=color, backgroundcolor=gray, frame=off] + +\startinteractionmenu[bottom] +\hfill +\startbut [content] contents \stopbut \quad +\startbut [index] index \stopbut \quad +\startbut [PreviousJump] last location \stopbut \quad +\startbut [NextPage] next page \stopbut \quad +\startbut [CloseDocument] exit \stopbut \quad +\stopinteractionmenu + +\starttext + +\startstandardmakeup + \midaligned{\tfd Festivities in Hasselt} +\stopstandardmakeup + +\completecontent + +\startchapter[title=Introduction] + An introduction. +\stopchapter + +\startchapter[title=Kingsday] + Something about Kingsday in Hasselt.\index{Kingsday} +\stopchapter + +\startchapter[title=Hassailt] + Something about Hassailt.\index{Hassailt} +\stopchapter + +\startchapter[title=Euifeest,reference=euifeest] + Something about the Euifeest.\index{Euifeest} +\stopchapter + +\completeindex + +\stoptext +\stopbuffer + +\typebuffer + +The definition of the \type{\startinteractionmenu} will produce a menu at the +bottom of every screen. The menu buttons contain the text {\em contents}, {\em +index}, {\em last location}, {\em next page} and {\em exit} with respectively the +following functions: jump to the table of contents, jump to the index, goto the +last location in the document, goto next page and close the document. The labels +to obvious destinations like \type{content} and \type{index} are predefined. +Other predefined destinations are \type{FirstPage}, \type{LastPage}, +\type{NextPage} and \type{PreviousPage}. + +An action like \type{CloseDocument} is necessary to make an electronic document +self containing. Other predefined actions you can use are \type{PrintDocument}, +\type{SearchDocument} and \type{PreviousJump}. The meaning of these actions is +obvious. + +\stopsection + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-introduction.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-introduction.tex new file mode 100644 index 000000000..11acf8f9c --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-introduction.tex @@ -0,0 +1,33 @@ +\startcomponent ma-cb-en-introduction + +\project ma-cb + +\startchapter[title=Introduction] + +\CONTEXT\ is a document engineering system based on \TEX, a typesetting +system and programming language to typeset and produce documents. Ths system is +easy to use and enables you to make complex paper and electronic documents. + +This manual describes the capabilities of \CONTEXT\ \MKIV, the available commands +and their functionality.\footnote {All paper and electronic products around +\CONTEXT\ are produced with \CONTEXT. All sources of these products are or will +be made available electronically to give you insight in the way these products +are made up.} + +This system is developed for practical applications: the typesetting and +production of documents ranging from simple straight forward books up to very +complex and advanced technical manuals and textbooks in a paper or an electronic +version. This introductory manual describes the functionality necessary to apply +standard text elements in a manual or textbook. \CONTEXT, however, is capable of +much more and for users who want more there are other manuals and sources +available. + +\CONTEXT\ has a multi lingual interface to enable users to work with the system +in their own language. This manual is available in Dutch and English. + +If you want to install \CONTEXT\ on your computer you can follow the installation +description on the \goto {\CONTEXTWIKI} [url(install)]. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-itemizations.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-itemizations.tex new file mode 100644 index 000000000..ac711be63 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-itemizations.tex @@ -0,0 +1,297 @@ +\startcomponent ma-cb-en-itemizations + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=itemize,title=Itemize] + +\index{itemize} +\index{columns in itemize} + +\Command{\tex{startitemize}} +\Command{\tex{setupitemize}} +\Command{\tex{definesymbol}} +\Command{\tex{item}} +\Command{\tex{head}} + +One way of structuring your information is by way of enumeration or summing up +items. The itemize command looks like this: + +\shortsetup{startitemize} + +For example: + +\startbuffer +\startitemize[R,packed,broad] +\item Hasselt was founded in the 14th century. +\item Hasselt is known as a so called Hanze town. +\item Hasselt's name stems from a tree. +\stopitemize +\stopbuffer + +\typebuffer + +Within the \type{\start ... \stopitemize} pair you start a new item with +\type{\item}. The space after \type{\item} is required. In the example above +\type{R} specifies Roman numbering and \type{packed} keeps line spacing to a +minimum. The parameter \type{broad} takes care of the spacing between item +separator and item. The example would produce: + +\getbuffer + +Items can be defined in a more structured way: + +\startbuffer +\startitemize[R,packed,broad] +\startitem Hasselt was founded in the 14th century. \stopitem +\startitem Hasselt is known as a so called Hanze town. \stopitem +\startitem Hasselt's name stems from a tree. \stopitem +\stopitemize +\stopbuffer + +\typebuffer + +The bracket pair contains information on item separators and local set up +variables. + +\placetable + [here] + [tab:itemsetup] + {Item separators in itemize.} + {\starttable[|l|l|] + \HL + \NC \bf Argument \NC \bf Item separator symbol \NC\SR + \HL + \NC 1 \NC $\bullet$ \NC\FR + \NC 2 \NC $-$ \NC\MR + \NC 3 \NC $\star$ \NC\MR + \NC $\vdots$ \NC $\vdots$ \NC\MR + \NC n \NC 1 2 3 4 $\cdots$ \NC\MR + \NC a \NC a b c d $\cdots$ \NC\MR + \NC A \NC A B C D $\cdots$ \NC\MR + \NC r \NC i ii iii iv $\cdots$ \NC\MR + \NC R \NC I II III IV $\cdots$ \NC\LR + \HL + \stoptable} + +You can also define your own item separator by means of \type{\definesymbol}. For +example if you try this: + +\startbuffer +\definesymbol[5][$\clubsuit$] + +\startitemize[5,packed] +\item Hasselt was built on a riverdune. +\item Hasselt lies at the crossing of two rivers. +\stopitemize +\stopbuffer + +\typebuffer + +You will get: + +\getbuffer + +If you want to have a sort of head within an enumeration you should use +\type{\head} instead of \type{\item}. + +\startbuffer +Hasselt lies in the province of Overijssel and there are a number +of customs that are typical of this province. + +\startitemize + +\head kraamschudden \hfill (child welcoming) + + When a child is born the neighbours come to visit the new + parents. The women come to admire the baby and the men come to + judge the baby (if it is a boy) on other aspects. + The neighbours will bring a {\em krentenwegge} along. A + krentenwegge is a loaf of currant bread of about 1 \unit{Meter} + long. Of course the birth is celebrated with {\em jenever}. + +\head nabuurschap (naberschop) \hfill (neighbourship) + + Smaller communities used to be very dependent on the + cooperation among the members for their well being. Members of + the {\em nabuurschap} helped each other in difficult times + during harvest times, funerals or any hardship that fell upon + the community. + +\head Abraham \& Sarah \hfill (identical) + + When people turn 50 in Hasselt it is said that they see Abraham + or Sarah. The custom is to give these people a {\em speculaas} + Abraham or a Sarah. Speculaas is a kind of hard spiced biscuit. + +\stopitemize +\stopbuffer + +\typebuffer + +The \type{\head} can be set up with \type{\setupitemize}. In case of a page +breaking a \type{\head} will appear on a new page. (The \type {\unit{Meter}} +command is explained in \in {chapter} [units].) + +The example of old customs will look like this: + +\getbuffer + +The set up parameters of itemize are described in \in {table} [tab:itemizesetup]. + +\placetable + [here,force] + [tab:itemizesetup] + {Set up parameters in itemize.} + {\starttable[|l|l|] + \HL + \NC \bf Set up \NC \bf Meaning \NC\SR + \HL + \NC standard \NC standard (global) set up \NC\FR + \NC packed \NC no vertical spacing between items \NC\MR + \NC serried \NC no horizontal spacing between separator and text \NC\MR + \NC joinedup \NC no vertical spacing before and after itemize \NC\MR + \NC broad \NC horizontal spacing between separator and text \NC\MR + \NC inmargin \NC place separator in margin \NC\MR + \NC atmargin \NC place separator on margin \NC\MR + \NC stopper \NC place full stop after separator \NC\MR + \NC columns \NC put items in columns \NC\MR + \NC intro \NC prevent page breaking after introduction line \NC\MR + \NC continue \NC continue numbering or lettering \NC\LR + \HL + \stoptable} + +You can use the set up parameters in \type{\startitemize}, but for reasons of +consistency you can make them valid for the complete document with +\type{\setupitemize}. + +The parameter \type{columns} is used in conjunction with +a (written) number. If you type this: + +\startbuffer +\startitemize[n,columns,four] +\item Achter 't Werk +. +. +. +\item Justitiebastion +\stopitemize +\stopbuffer + +\typebuffer + +\page[bigpreference] + +You will get: + +\startbuffer +\startitemize[n,packed,columns,four,broad] +\item Achter 't Werk +\item Baangracht +\item Brouwersgracht +\item Eikenlaan +\item Eiland +\item Gasthuisstraat +\item Heerengracht +\item Hofstraat +\item Hoogstraat +\item Julianakade +\item Justitiebastion +\item Kaai +\item Kalverstraat +\item Kastanjelaan +\item Keppelstraat +\stopitemize +\stopbuffer + +\bgroup +\getbuffer +\egroup + +Sometimes you want to continue the enumeration after a short intermezzo. Then you +type for example \type{\startitemize[continue]} and numbering +will continue and all other preferences are kept. + +\startbuffer +\startitemize[continue] +\item Markt +\item Meestersteeg +\item Prinsengracht +\item Raamstraat +\item Ridderstraat +\item Rosmolenstraat +\item Royenplein +\item Van Nahuijsweg +\item Vicariehof +\item Vissteeg +\item Watersteeg +\item Wilhelminalaan +\item Ziekenhuisstraat +\stopitemize +\stopbuffer + +\getbuffer + +The parameter \type{broad} enlarges the horizontal space between item separator +and itemtext. + +\shortsetup{setupitemize} + +An itemize within an itemize is automatically typeset in a correct way. For +example if you type: + +\startbuffer +In the Netherlands the cities can determine the height of a number of +taxes. So the cost of living can differ from town to town. There are +differences of up to 50\% in taxes such as: + +\setupitemize[2][width=5em] +\startitemize[n] + +\item[estate tax] real estate tax + + The real estate tax is divided into two components: + + \startitemize[a,packed] + \item the ownership tax + \item the tenant tax + \stopitemize + + If the real estate has no tenant the owner pays both components. + +\item dog licence fee + + The owner of one or more dogs pays a fee. When a dog has died + or been sold the owner has to inform city hall. + +\stopitemize +\stopbuffer + +\typebuffer + +then the horizontal space between item separator and text at the second level of +itemizing is set with \type{\setupitemize[2][width=5em]}. + +The example will look like this: + +\start +\getbuffer +\stop + +You can refer to an item if you give it a label (see \type{\item[estate tax]}). +If you then type: + +\startbuffer +\in{In item}[estate tax] we discussed one of the income sources of Hasselt. +\stopbuffer + +\typebuffer + +You'll get a reference to that item: + +\getbuffer + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-layout.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-layout.tex new file mode 100644 index 000000000..243f96b15 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-layout.tex @@ -0,0 +1,241 @@ +\startcomponent ma-cb-en-layout + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Page layout] + +\index{layout} +\index{page design} + +\Command{\tex{setuplayout}} +\Command{\tex{adaptlayout}} +\Command{\tex{showlayout}} +\Command{\tex{showframe}} % VZ 2006-11-15 +\Command{\tex{showsetups}} +\Command{\tex{showmakeup}} +\Command{\tex{startlocal}} + +\startsection[title=Introduction] + +The {\em Layouts in \CONTEXT} manual by Willy Egger contains the necessary +background information on page layout and design. Below you will find only the +basic information necessary for defining rather simple layouts for paper and +screen documents. + +For more information (examples and usage) on the \type{\setuplayout} command +please refer to the +\goto {\CONTEXTWIKI} [ url(http://wiki.contextgarden.net/Layout) ]. + +\stopsection + +\startsection[title=Designing the pagelayout] + +To be able to design a page layout you have to familiarize yourself with the +pagemodel of \CONTEXT. \in{Figure}[fig:pageareas] shows the areas on a page +that you can use in your design. + +\placefigure + [here] + [fig:pageareas] + {The page areas.} + {\externalfigure[fig-page-areas-en.pdf][width=.75\hsize]} + +The orange bodytext area contains the running text. The top, bottom, and edge +area are useful for buttons in screen documents. + +Please keep in mind that in \CONTEXT\ you are defining|/|designing a +right-hand page. Only after you have setup +\type{\setuppagenumbering[alternative=doublesided]} the left page +is available (mirrored right page). + +\starthiding + % AFO: this is the file minibook-en.tex in graphics map + \setuppapersize[A10][A10] + \setuplayout[cutspace=2mm,backspace=6mm,width=15mm] + \setupbodyfont[6pt] + \setuppagenumbering[state=stop] + \setupbackgrounds[text][text][background=color,backgroundcolor=orange] + \setupbackgrounds[header,text,footer][leftmargin][background=color,backgroundcolor=lightgreen] + \setupbackgrounds[header,text,footer][leftmargin,text,rightmargin][frame=on] + \setupfootertexts[margin][\midaligned{l}][\midaligned{r}][\midaligned{r}][\midaligned{l}] + \starttext + \midaligned{design page} \page + \setuppagenumbering[alternative={singlesided}] + \inmargin{\midaligned{m}}\midaligned{left page} \page + \inmargin{\midaligned{m}}\midaligned{right page} \page + \setuppagenumbering[alternative={singlesided,doublesided}] + \inmargin{\midaligned{m}}\midaligned{left page} \page + \inmargin{\midaligned{m}}\midaligned{right page} \page + \setuppagenumbering[alternative={doublesided}] + \inmargin{\midaligned{m}}\midaligned{left page} \page + \inmargin{\midaligned{m}}\midaligned{right page} + \stoptext +\stophiding + +\placefigure + [here] + [fig:sidedness] + {Page alternatives.} + {\startcombination[3*1] + {\externalfigure[minibook-en.pdf][type=pdf,page=2,width=2.4cm]\externalfigure[minibook-en.pdf][type=pdf,page=3,width=2.4cm]}{singlesided} + {\externalfigure[minibook-en.pdf][type=pdf,page=4,width=2.4cm]\externalfigure[minibook-en.pdf][type=pdf,page=5,width=2.4cm]}{single-double} + {\externalfigure[minibook-en.pdf][type=pdf,page=6,width=2.4cm]\externalfigure[minibook-en.pdf][type=pdf,page=7,width=2.4cm]}{doublesided} + \stopcombination} + +Note in \in{figure}[fig:sidedness] that: + +\startitemize[packed] +\item the margintext (\type{\inmargin{m}}) is always in the left margin +\item the footertext in the margin (\type{\setupfootertexts[margin][l][r][r][l]}) adapts automatically +\item the page is completely mirrored when \type{alternative=doublesided} +\stopitemize + +When designing a page ask yourself a few questions: + +\startitemize[packed] +\item do I want margin texts or margin figures +\item will I use the margin for the section numbering +\item do I have footer and/or header texts +\item do I want a double sided layout (right--left page mirrored) +\item do I use ornaments (like tabs) on the page +\item do I have navigational buttons (screen documents) +\stopitemize + +\stopsection + +\startsection[title=Defining the papersize / screensize] + +Before you can set up your page layout you have to have an idea about the paper +dimensions. The cutmarks connected by the dashed lines in \in{figure}[fig:pageareas] +indicate the papersize. In \CONTEXT\ you set up your papersize with: + +\shortsetup{\tex{setuppapersize}} + +Most common predefined papersizes in \CONTEXT\ are A0..A10 and B1..B10 for paper +and S3..S8 for screen documents. + +Mostly you will use the default setup: + +\startbuffer +\setuppapersize + [A4][A4] +\stopbuffer + +\typebuffer + +But you can also define your own paper size for specific products: + +\startbuffer +\definelayout + [postcard] + [width=15cm, + height=10cm] +\stopbuffer + +\typebuffer + +\stopsection + +\startsection[title=Defining the page layout] + +The page layout is defined by: + +\shortsetup{setuplayout} + +This command is typed in the set up area of your input file. + +\placefigure + [here] + [fig:pageparameters] + {The page parameters.} + {\externalfigure[fig-page-parameters-en.pdf][width=.8\hsize]} + +The layout of this manual was set with: + +\startbuffer +\setuplayout + [backspace=3cm, + margin=2cm, + margindistance=.5cm, + width=15cm, + topspace=2cm, + header=2cm, + footer=2cm, + height=25.7cm] +\stopbuffer + +\typebuffer + +If you want to look at your page layout you can type the command +\type{\showframe} and process one page or the whole file. The areas are shown in +a number of frames. + +The command \type{\showsetups} shows the values of the parameters. A combination +of both commands is \type{\showlayout}. + +The values of the layout parameters are available as commands. This enables you +to work more accurately when defining measures of columns, figures and tables. A +few of these parameters are explained in \in{table}[tab:fewparameters]. + +\placetable + [here,force] + [tab:fewparameters] + {A few parameters as commands.} +\starttable[|l|l|] +\HL +\NC \bf Commands \NC \bf Meaning \NC\SR +\HL +\NC \type{\makeupwidth} \NC width of the typing area \NC\FR +\NC \type{\makeupheight} \NC height of the typing area \NC\MR +\NC \type{\textwidth} \NC width of the text area \NC\MR +\NC \type{\textheight} \NC height of the text area \NC\LR +\HL +\stoptable + +If you want to define the width of a column or the height of a figure you can do +it relative to the \type{\makeupwidth} or \type{\makeupheight}. Changes in this +width or height will alter columns and figures proportionally. + +\startbuffer +\placefigure + [here] + [fig:stepgable] + {A stepgable.} + {\externalfigure[ma-cb-19][width=.6\textwidth]} +\stopbuffer + +\typebuffer + +After processing this would become: + +\getbuffer + +The other available values are (shown with \type{\showsetups}): + +\startcolumns +\switchtobodyfont[8pt] +\showsetups +\stopcolumns + +The parameter values have a global effect and are default throughout the +document. Nevertheless you might want to make slight changes in the page design +for a number of pages. + +\startbuffer +\adaptlayout[21,38][height=+.5cm] +\stopbuffer + +\typebuffer + +In this case page 21 and 38 have a height of .5~cm + \type{textheight}. + +It is advisable not to use these local changes too often. It is always better to +alter the text than to change the page layout. + +\stopsection + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-margintexts.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-margintexts.tex new file mode 100644 index 000000000..54ed6db6a --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-margintexts.tex @@ -0,0 +1,100 @@ +\startcomponent ma-cb-en-margintexts + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Margin texts] + +\index{margin text} + +\Command{\tex{margintext}} +\Command{\tex{inmargin}} +\Command{\tex{inleft}} +\Command{\tex{inright}} +\Command{\tex{margintitle}} + +It is very easy to put text in the margin. You just use \type{\inmargin}. + +\shortsetup{inmargin} + +You may remember one of the earlier examples: + +\startbuffer[marginpicture] +\inmargin + {\externalfigure + [ma-cb-23] + [width=.6\marginwidth]} +\stopbuffer + +\typebuffer[marginpicture] + +This would result in a figure in the \pagereference [marginpicture] +margin. You can imagine that it looks quite nice in some +documents. But be careful. The margin is rather small so the figure could become +very marginal. + +A few other examples are shown in the text below.\getbuffer +[marginpicture] + +\startbuffer +The Ridderstraat (Street of knights) \inmargin{Street of\\Knights} +is an obvious name. In the 14th and 15th centuries, nobility and +prominent citizens lived in this street. Some of their big houses +were later turned into poorhouses \inright{poorhouse}and old +peoples homes. + +Up until \inleft[low]{\tfc 1940}1940 there was a synagog in the +Ridderstraat. Some 40 Jews gathered there to celebrate their +sabbath. During the war all Jews were deported to Westerbork and +then to the extermination camps in Germany and Poland. None of +the Jewish families returned. The synagog was knocked down in +1958. +\stopbuffer + +\typebuffer + +The commands \type{\inmargin}, \type{\inleft} and \type{\inright} all have the +same function. In a two sided document \type{\inmargin} puts the margin text in +the correct margin. The \type{\\} is used for line breaking. The example above +would look like this: + +\getbuffer + +You can set up the margin text with: + +\shortsetup{setupinmargin} + +Other commands that you can use for forcing text into the margin +are listed in \in{table}[tab:margincommands]. + +\placetable + [here] + [tab:margincommands] + {Overview of margin commands.} + {\starttable[|l|l|] + \HL + \NC \bf Command \NC \bf Meaning \NC\SR + \HL + \NC \type{\ininner} \NC text in inner margin \NC\FR + \NC \type{\inouter} \NC text in outer margin \NC\MR + \NC \type{\inright} \NC text in right margin \NC\MR + \NC \type{\inleft} \NC text in left margin \NC\MR + \NC \type{\inmargin} \NC text in the margin \NC\MR + \NC \type{\inothermargin} \NC text in other margin \NC\MR + \NC \type{\margintext} \NC text in the margin \NC\LR + \HL + \stoptable} + +If you want to place more extensive text blocks in the margin there is the +command: + +\shortsetup{marginblock} + +and the accompanying command: + +\shortsetup{setupmarginblocks} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-math.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-math.tex new file mode 100644 index 000000000..c1430603f --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-math.tex @@ -0,0 +1,524 @@ +\startcomponent ma-cb-en-math + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=formulas,title=Typesetting math] + +\startsection[title=Introduction] + +\index {math} + +\TEX\ is {\em the} typesetting program for math. However, this is not the +extensive chapter on typesetting math you might expect. We advise you to do some +further reading on typesetting formulas in \TEX. See for example: \footnote{In +this introduction on typesetting math we relied on the booklet {\em \TEX niques} +by Arthur Samuel.} + +\startitemize[packed] +\item {\em The \TeX Book} by D.E. Knuth +\item {\em The Beginners Book of \TeX} by S. Levy and R. Seroul +\stopitemize + +\startsection[title=Typesetting math] + +\index {math mode} +\index {display mode} +\index {text mode} + +Normally different conventions are applied for typesetting normal text and math +text. These conventions are \quote{known} by \TEX\ and applied accordingly when +generating a document. We can rely on \TEX\ for delivering high quality math +output. + +A number of conventions for math are: + +\startitemize[n,packed] + +\item Characters are typeset in $math\ italic$ (don't confuse this with the + normal {\it italic characters} in a font). + +\item Symbols like Greek characters ($\alpha$, $\chi$) and math symbols ($\leq$, + $\geq$, $\in$) are used. + +\item Spacing will differ from normal spacing. + +\item Math expressions have a different alignment than that of the running text. + +\item The sub and superscripts are downsized automatically, like in $a^{b}_{c}$. + +\item Certain symbols have different appearances in the inline and display mode. + +\stopitemize + +When typesetting math you have to work in the so called math mode in which math +expressions can be defined by means of plain \TEX||commands. + +Math mode has two alternatives: text mode and display mode. Math in text +mode is activated by \type{$} and \type{$}, while display mode is activated by +\type{$$} and \type{$$}. In \CONTEXT\ however, display mode is activated with +the \type{\start ... \stopformula} command pair to have more grip on vertical +spacing around the formula. + +\startbuffer +The municipality of Hasselt covers an area of 42,05 \unit{Square Kilo +Meter}. Now, if you consider a circular area of this size with the +market place of Hasselt as the center point $M$ you can calculate its +diameter with ${{1}\over{4}} \pi r^2$. +\stopbuffer + +\typebuffer + +This will become: + +\getbuffer + +The many \type{{}} (grouping) in ${{1}\over{4}} \pi r^2$ are essential for +separating operations in the expression. If you omit the outer curly braces like +this: \type{${1}\over{4} \pi r^2$}, you would get a non desired result: +${1}\over{4} \pi r^2$. + +The letters and numbers are typeset in three different sizes: text size $a+b$, +script size $\scriptstyle a+b$ and scriptscript size $\scriptscriptstyle a+b$. +These can be influenced by the commands \type{\scriptstyle} and +\type{\scriptscriptstyle}. + +Symbols like $\int$ and $\sum$ will have a different form in text and display +mode. If we type \type {$\sum_{n=1}^{m}$} or \type {$\int_{-\infty}^{+\infty}$} +we will get {$\sum_{n=1}^{m}$} and {$\int_{-\infty}^{+\infty}$}. But when you +type: + +\startbuffer +\startformula + \sum_{n=1}^{m} \quad {\rm and} \quad \int_{-\infty}^{+\infty} +\stopformula +\stopbuffer + +\typebuffer + +to get displaymode you get: + +\getbuffer + +With the commands \type {\nolimits} and \type{\limits} you can influence the +appearances of \type{\sum} and \type{\int}: + +\startbuffer +\startformula + \sum_{n=1}^{m}\nolimits + \quad {\rm and} \quad + \int_{-\infty}^{+\infty}\limits +\stopformula +\stopbuffer + +\typebuffer + +which will result in: + +\getbuffer + +For typesetting fractions there is the command \type {\over}. In \CONTEXT\ you +can use the alternative \type {\frac}. For ${\frac{a}{1+b}}+c$ we type for +instance \type {${\frac{a}{1+b}}+c$}. + +Other commands to put one thing above the other, are: + +\startbuffer[atop] +${a} \atop {b}$ +\stopbuffer +\startbuffer[choose] +${n+1} \choose {k}$ +\stopbuffer +\startbuffer[brack] +${m} \brack {n}$ +\stopbuffer +\startbuffer[brace] +${m} \brace {n-1}$ +\stopbuffer + +\starttabulate[|l|l|l|l|] +\NC \type {\atop} +\NC \typebuffer[atop] +\NC \mathstrut\getbuffer[atop] +\NC +\NC\NR +\NC \type {\choose} +\NC \typebuffer[choose] +\NC +\NC \mathstrut\getbuffer[choose] +\NC\NR +\NC \type {\brack} +\NC \typebuffer[brack] +\NC \mathstrut\getbuffer[brack] +\NC +\NC\NR +\NC \type {\brace} +\NC \typebuffer[brace] +\NC +\NC \mathstrut\getbuffer[brace] +\NC\NR +\stoptabulate + +\TEX\ can enlarge delimiters like (~) and $\{~\}$ automatically if the left and +right delimiter is preceeded by the commands \type {\left} and \type {\right} +respectively. If you type: + +\startbuffer +\startformula + 1+\left(\frac{1}{1-x^{x-2}}\right)^3 +\stopformula +\stopbuffer + +\typebuffer + +you will get: + +\getbuffer + +Sub and superscripts are invoked by \quote {\type{_}} and \quote {\type{^}}. They +have effect on the next first character so grouping with $\{$~$\}$ is necessary +in case of multi character sub and superscripts. + +In certain situations the delimiters can be preceeded by \type{\bigl}, +\type{\Bigl}, \type{\biggl} and \type{\Biggl} and their right counterparts. Even +bigger delimiters can be produced by placing \type{\left} and \type{\right} in a +\type{\vbox} construction. When we type a senseless expression like: + +\startbuffer +\startformula + \left(\vbox to 16pt{}x^{2^{2^{2^{2}}}}\right) +\stopformula +\stopbuffer + +\typebuffer + +we get: + +\getbuffer + +In display mode the following delimiters will work in the automatic enlargement +mechanism: + +\starttabulate[|l|l|l|l|l|l|l|l|] +\NC \type{\lfloor} \NC $\lfloor$ +\NC \type{\langle} \NC $\langle$ +\NC \type{\vert} \NC $\vert$ +\NC \type{\downarrow} \NC $\downarrow$ +\NC\NR +\NC \type{\rfloor} \NC $\rfloor$ +\NC \type{\rangle} \NC $\rangle$ +\NC \type{\Vert} \NC $\Vert$ +\NC \type{\Downarrow} \NC $\Downarrow$ +\NC\NR +\NC \type{\lceil} \NC $\lceil$ +\NC \type{/} \NC $/$ +\NC \type{\uparrow} \NC $\uparrow$ +\NC \type{\updownarrow} \NC $\updownarrow$ +\NC\NR +\NC \type{\rceil} \NC $\rceil$ +\NC \type{\backslash} \NC $\backslash$ +\NC \type{\Uparrow} \NC $\Uparrow$ +\NC \type{\Updownarrow} \NC $\Updownarrow$ +\NC\NR +\stoptabulate + +In display mode we should typeset only one fraction and otherwise switch to the +\type{a/b} notation. To get: + +\startformula + a_0 + {\frac{a}{a_1 + \frac{1}{a_2}}} +\stopformula + +we will not type: + +\startbuffer +\startformula + a_0+{\frac{a}{a_1+\frac{1}{a_2}}} +\stopformula +\stopbuffer + +\typebuffer + +but prefer: + +\startbuffer +\startformula + a_0 + {\frac{a}{a_1 + 1/a_2}} +\stopformula +\stopbuffer + +\typebuffer + +to obtain: + +\getbuffer + +In addition we could also use the command \type{\displaystyle}. If we would type: + +\startbuffer +\startformula + a_0 + {\frac{a}{a_1 + \frac{1}{\strut \displaystyle a_2}}} +\stopformula +\stopbuffer + +\getbuffer + +we will get: + +\getbuffer + +Below we demonstrate the commands \type{\matrix}, \type{\pmatrix}, \type{\ldots}, +\type{\cdots} and \type{\cases} without any further explanation. + +\startbuffer[a] +\startformula +\stopbuffer + +\startbuffer[c] +\stopformula +\stopbuffer + +\startbuffer[b] + A=\left(\matrix{x-\lambda & 1 & 0 \cr + 0 & x-\lambda & 1 \cr + 0 & 0 & x-\lambda \cr}\right) +\stopbuffer + +\typebuffer[a,b,c] \startformula\getbuffer[b]\stopformula + +\startbuffer[b] + A=\left|\matrix{x-\mu& 1 & 0 \cr + 0 & x-\mu & 1 \cr + 0 & 0 & x-\mu \cr}\right| +\stopbuffer + +\typebuffer[a,b,c] \startformula\getbuffer[b]\stopformula + +\startbuffer[b] + A=\pmatrix{a_{11} & a_{12} & \ldots & a_{1n} \cr + a_{21} & a_{22} & \ldots & a_{2n} \cr + \vdots & \vdots & \ddots & \vdots \cr + a_{m1} & a_{m2} & \ldots & a_{mn} \cr} +\stopbuffer + +\typebuffer[a,b,c] \startformula\getbuffer[b]\stopformula + +\startbuffer[b] + A=\pmatrix{a_{11} & a_{12} & \ldots & a_{1n} \cr + a_{21} & a_{22} & \ldots & a_{2n} \cr + \vdots & \vdots & \ddots & \vdots \cr + a_{m1} & a_{m2} & \ldots & a_{mn} \cr} +\stopbuffer + +\typebuffer[a,b,c] \startformula\getbuffer[b]\stopformula + +\startbuffer[b] + |x|=\cases{ x, & if $x\geq0$; \cr + -x, & otherwise \cr} +\stopbuffer + +\typebuffer[a,b,c] \startformula\getbuffer[b]\stopformula + +To typeset normal text in a math expression we have to consider the following. +First a space is not typeset in math mode so we have to enforce one with +\type{ \ } (backslash). Second we have to indicate a font switch, because the text should +not appear in $math\ italic$ but in the actual font. So in \CONTEXT\ we have to +type: + +\startbuffer +\startformula + x^3+{\tf lower\ order\ terms} +\stopformula +\stopbuffer + +\typebuffer + +to get: + +\getbuffer + +The math functions like $\sin$ and $\tan$ that have to be typeset in the actual +font are predefined functions in \TEX: + +\starttabulate[|l|l|l|l|l|l|l|l|] +\NC \type{\arccos} \NC \type{\cos} \NC \type{\csc} \NC \type{\exp} \NC \type{\ker} \NC \type{\limsup} \NC \type{\min} \NC \type{\sinh} \NC\NR +\NC \type{\arcsin} \NC \type{\cosh} \NC \type{\deg} \NC \type{\gcd} \NC \type{\lg} \NC \type{\ln} \NC \type{\Pr} \NC \type{\sup} \NC\NR +\NC \type{\arctan} \NC \type{\cot} \NC \type{\det} \NC \type{\hom} \NC \type{\lim} \NC \type{\log} \NC \type{\sec} \NC \type{\tan} \NC\NR +\NC \type{\arg} \NC \type{\coth} \NC \type{\dim} \NC \type{\inf} \NC \type{\liminf} \NC \type{\max} \NC \type{\sin} \NC \type{\tanh} \NC\NR +\stoptabulate + +If we type the sinus or limit function: + +\startbuffer +\startformula + \sin 2\theta=2\sin\theta\cos\theta + \quad {\tf or} \quad + \lim_{x\to0}{\frac{\sin x}{x}}=1 +\stopformula +\stopbuffer + +\typebuffer + +we get: + +\getbuffer + +Alignment in math expressions may need special attention. In multi line +expressions we sometimes need alignment at the \quote {$=$} sign. This is done by +the command \type{\eqalign}. If we type: + +\startbuffer +\startformula + \eqalign{ + ax^2+bx+c &= 0 \cr + x &= \frac{-b \pm \sqrt{b^2-4ac}}{2a} \cr} +\stopformula +\stopbuffer + +\typebuffer + +we get: + +\getbuffer + +Sometimes alignment at more than one location is wanted. Watch the second line in +the next example and see how it is defined: + +\startbuffer +\startformula + \eqalign{ + ax+bx+\cdots+yx+zx & = x(a +b+ \cdots \cr + &\phantom{= x(a~}+y+z) \cr + & = y \cr} +\stopformula +\stopbuffer + +\typebuffer + +This results in: + +\getbuffer + +Next to the command \type{\phantom} there are \type{\hphantom} without height and +depth and \type{\vphantom} without width. + +You can rely on \TEX\ for spacing within a math expression. In some situations, +however you may want to influence spacing. This is done by: + +\starttabulate[|l|r|] +\NC \type{\!} \NC $-\frac{1}{6}$\type{\quad} \NC\NR +\NC \type{\,} \NC $\frac{1}{6}$\type{\quad} \NC\NR +\NC \type{\>} \NC $\frac{2}{9}$\type{\quad} \NC\NR +\NC \type{\;} \NC $\frac{5}{18}$\type{\quad} \NC\NR +\stoptabulate + +These \quote {spaces} are related to \type {\quad} that stands for the width of +the capital \quote{M}. + +The use of the command \type{\prime} speaks for itself. For example if would want +$y_1^\prime+y_2^{\prime\prime}$ you should type +\type{$y_1^\prime+y_2^{\prime\prime}$}. + +An expression like $\root 3 \of {x^2+y^2}$ is obtained by \type{$\root 3 \of +{x^2+y^2}$}. + +At the end of this section we point to the command \type{\mathstrut} which we can +use to enforce consistency, for example within the root symbol. With +\type{$\sqrt{\mathstrut a}+\sqrt{\mathstrut d}+\sqrt{\mathstrut y}$} we will get +$\sqrt{\mathstrut a}+\sqrt{\mathstrut d}+\sqrt{\mathstrut y}$ in stead of +$\sqrt{a}+\sqrt{d}+\sqrt{y}$. + +See \in{appendix}[overviews] for a complete overview of math commands. + +\stopsection + +\startsection[title=Placing formulas] + +\index{formula} + +\Command{\tex{placeformula}} +\Command{\tex{startformula}} +\Command{\tex{setupformulas}} + +You can typeset numbered formulas with: + +\shortsetup{placeformula} +\shortsetup{startformula} + +Two examples: + +\startbuffer +\placeformula[formula:aformula] + \startformula + y=x^2 + \stopformula + +\placeformula + \startformula + \int_0^1 x^2 dx + \stopformula +\stopbuffer + +\typebuffer + +\getbuffer + +The command \type{\placeformula} handles spacing around the formulas and the +numbering. The bracket pair is optional and is used for referencing and to switch +numbering on and off. + +\startbuffer +\placeformula[first one] +\startformula + y=x^2 +\stopformula + +\placeformula[middle one] +\startformula + y=x^3 +\stopformula + +\placeformula[last one] +\startformula + y=x^4 +\stopformula +\stopbuffer + +\getbuffer + +\in{Formula}[middle one] was typed like this: + +\startbuffer +\placeformula[middle one] + \startformula + y=x^3 + \stopformula +\stopbuffer + +\typebuffer + +The lable \type{[middle one]} is used for refering to this formula. Such a +reference is made with \type{\in{formula}[middle one]}. + +If no numbering is required you type: + +\type{\placeformula[-]} + +Numbering of formulas is set up with \type{\setupnumbering}. In this manual +numbering is set up with \type{\setupnumbering[way=bychapter]}. This means that +the chapter number preceeds the formula number and numbering is reset with each +new chapter. For reasons of consistency the tables, figures, intermezzi etc. are +numbered in the same way. Therefore you use \type{\setupnumbering} in the set up +area of your input file. + +Formulas can be set up with: + +\shortsetup{setupformulae} + +\stopsection + +\stopchapter + +\stopcomponent + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-mathcharacters.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-mathcharacters.tex new file mode 100644 index 000000000..d7f09e89a --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-mathcharacters.tex @@ -0,0 +1,330 @@ +\startcomponent ma-cb-en-mathcharacters + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=overviews,title=Commands in math mode] + +\index{symbols in math mode} + +\startsection[title=Greek characters] + +\starttabulate[|l|l|l|l|l|l|l|l|l|] +\NC \NC $\alpha$ \NC \type{\alpha} +\NC \NC $\iota$ \NC \type{\iota} +\NC \NC $\varrho$ \NC \type{\varrho} \NC\NR +\NC \NC $\beta$ \NC \type{\beta} +\NC \NC $\kappa$ \NC \type{\kappa} +\NC $\Sigma$ \NC $\sigma$ \NC \type{\sigma} \NC\NR +\NC $\Gamma$ \NC $\gamma$ \NC \type{\gamma} +\NC $\Lambda$ \NC $\lambda$ \NC \type{\lambda} +\NC \NC $\varsigma$ \NC \type{\varsigma} \NC\NR +\NC $\Delta$ \NC $\delta$ \NC \type{\delta} +\NC \NC $\mu$ \NC \type{\mu} +\NC \NC $\tau$ \NC \type{\tau} \NC\NR +\NC \NC $\epsilon$ \NC \type{\epsilon} +\NC \NC $\nu$ \NC \type{\nu} +\NC \NC $\upsilon$ \NC \type{\upsilon} \NC\NR +\NC \NC $\varepsilon$ \NC \type{\varepsilon} +\NC $\Xi$ \NC $\xi$ \NC \type{\xi} +\NC $\Phi$ \NC $\phi$ \NC \type{\phi} \NC\NR +\NC \NC $\zeta$ \NC \type{\zeta} +\NC \NC $o$ \NC \type{o} +\NC \NC $\varphi$ \NC \type{\varphi} \NC\NR +\NC \NC $\eta$ \NC \type{\eta} +\NC $\Pi$ \NC $\pi$ \NC \type{\pi} +\NC \NC $\chi$ \NC \type{\chi} \NC\NR +\NC $\Theta$ \NC $\theta$ \NC \type{\theta} +\NC \NC $\varpi$ \NC \type{\varpi} +\NC $\Psi$ \NC $\psi$ \NC \type{\psi} \NC\NR +\NC \NC $\vartheta$ \NC \type{\vartheta} +\NC \NC $\rho$ \NC \type{\rho} +\NC $\Omega$ \NC $\omega$ \NC \type{\omega} \NC\NR +\stoptabulate + +\stopsection + +\startsection[title=Special symbols] + +\starttabulate[|l|l|l|l|l|l|] +\NC $\aleph$ \NC \type{\aleph} +\NC $\prime$ \NC \type{\prime} +\NC $\forall$ \NC \type{\forall} +\NC\NR +\NC $\hbar$ \NC \type{\hbar} +\NC $\emptyset$ \NC \type{\emptyset} +\NC $\exists$ \NC \type{\exists} +\NC\NR +\NC $\imath$ \NC \type{\imath} +\NC $\nabla$ \NC \type{\nabla} +\NC $\neg$ \NC \type{\neg} +\NC\NR +\NC $\jmath$ \NC \type{\jmath} +\NC $\surd$ \NC \type{\surd} +\NC $\flat$ \NC \type{\flat} +\NC\NR +\NC $\ell$ \NC \type{\ell} +\NC $\top$ \NC \type{\top} +\NC $\natural$ \NC \type{\natural} +\NC\NR +\NC $\wp$ \NC \type{\wp} +\NC $\bot$ \NC \type{\bot} +\NC $\sharp$ \NC \type{\sharp} +\NC\NR +\NC $\Re$ \NC \type{\Re} +\NC $\Vert$ \NC \type{\Vert} +\NC $\clubsuit$ \NC \type{\clubsuit} +\NC\NR +\NC $\Im$ \NC \type{\Im} +\NC $\angle$ \NC \type{\angle} +\NC $\diamondsuit$ \NC \type{\diamondsuit} +\NC\NR +\NC $\partial$ \NC \type{\partial} +\NC $\triangle$ \NC \type{\triangle} +\NC $\heartsuit$ \NC \type{\heartsuit} +\NC\NR +\NC $\infty$ \NC \type{\infty} +\NC $\backslash$ \NC \type{\backslash} +\NC $\spadesuit$ \NC \type{\spadesuit} +\NC\NR +\stoptabulate + +\stopsection + +\startsection[title=Operators in addition to $+$, $-$ and $*$] + +\starttabulate[|l|l|l|l|l|l|] +\NC $\pm$ \NC \type{\pm} +\NC $\cap$ \NC \type{\cap} +\NC $\vee$ \NC \type{\vee} +\NC\NR +\NC $\mp$ \NC \type{\mp} +\NC $\cup$ \NC \type{\cup} +\NC $\wedge$ \NC \type{\wedge} +\NC\NR +\NC $\setminus$ \NC \type{\setminus} +\NC $\uplus$ \NC \type{\uplus} +\NC $\oplus$ \NC \type{\oplus} +\NC\NR +\NC $\cdot$ \NC \type{\cdot} +\NC $\sqcap$ \NC \type{\sqcap} +\NC $\ominus$ \NC \type{\ominus} +\NC\NR +\NC $\times$ \NC \type{\times} +\NC $\sqcup$ \NC \type{\sqcup} +\NC $\otimes$ \NC \type{\otimes} +\NC\NR +\NC $\ast$ \NC \type{\ast} +\NC $\triangleleft$ \NC \type{\triangleleft} +\NC $\oslash$ \NC \type{\oslash} +\NC\NR +\NC $\star$ \NC \type{\star} +\NC $\triangleright$ \NC \type{\triangleright} +\NC $\odot$ \NC \type{\odot} +\NC\NR +\NC $\diamond$ \NC \type{\diamond} +\NC $\wr$ \NC \type{\wr} +\NC $\dagger$ \NC \type{\dagger} +\NC\NR +\NC $\circ$ \NC \type{\circ} +\NC $\bigcirc$ \NC \type{\bigcirc} +\NC $\ddagger$ \NC \type{\ddagger} +\NC\NR +\NC $\bullet$ \NC \type{\bullet} +\NC $\bigtriangleup$ \NC \type{\bigtriangleup} +\NC $\amalg$ \NC \type{\amalg} +\NC\NR +\NC $\div$ \NC \type{\div} +\NC $\bigtriangledown$ \NC \type{\bigtriangledown} +\NC ~ \NC ~ +\NC\NR +\stoptabulate + +\stopsection + +\startsection[title=Operators] + +\starttabulate[|l|l|l|l|l|l|] +\NC $\sum$ \NC \type{\sum} +\NC $\prod$ \NC \type{\prod} +\NC $\coprod$ \NC \type{\coprod} +\NC\NR +\NC $\int$ \NC \type{\int} +\NC $\oint$ \NC \type{\oint} +\NC $\bigcap$ \NC \type{\bigcap} +\NC\NR +\NC $\bigcup$ \NC \type{\bigcup} +\NC $\bigsqcup$ \NC \type{\bigsqcup} +\NC $\bigvee$ \NC \type{\bigvee} +\NC\NR +\NC $\bigwedge$ \NC \type{\bigwedge} +\NC $\bigodot$ \NC \type{\bigodot} +\NC $\bigotimes$ \NC \type{\bigotimes} +\NC\NR +\NC $\bigoplus$ \NC \type{\bigoplus} +\NC $\biguplus$ \NC \type{\biguplus} +\NC \NC +\NC\NR +\stoptabulate + +\stopsection + +\startsection[title=Relation in addition to $>$, $<$ and $=$] + +\starttabulate[|l|l|l|l|l|l|] +\NC $\leq$ \NC \type{\leq} +\NC $\geq$ \NC \type{\geq} +\NC $\equiv$ \NC \type{\equiv} +\NC\NR +\NC $\prec$ \NC \type{\prec} +\NC $\succ$ \NC \type{\succ} +\NC $\sim$ \NC \type{\sim} +\NC\NR +\NC $\preceq$ \NC \type{\preceq} +\NC $\succeq$ \NC \type{\succeq} +\NC $\simeq$ \NC \type{\simeq} +\NC\NR +\NC $\ll$ \NC \type{\ll} +\NC $\gg$ \NC \type{\gg} +\NC $\asymp$ \NC \type{\asymp} +\NC\NR +\NC $\subset$ \NC \type{\subset} +\NC $\supset$ \NC \type{\supset} +\NC $\approx$ \NC \type{\approx} +\NC\NR +\NC $\subseteq$ \NC \type{\subseteq} +\NC $\supseteq$ \NC \type{\supseteq} +\NC $\cong$ \NC \type{\cong} +\NC\NR +\NC $\sqsubseteq$ \NC \type{\sqsubseteq} +\NC $\sqsupseteq$ \NC \type{\sqsupseteq} +\NC $\bowtie$ \NC \type{\bowtie} +\NC\NR +\NC $\in$ \NC \type{\in} +\NC $\ni$ \NC \type{\ni} +\NC $\propto$ \NC \type{\propto} +\NC\NR +\NC $\vdash$ \NC \type{\vdash} +\NC $\dashv$ \NC \type{\dashv} +\NC $\models$ \NC \type{\models} +\NC\NR +\NC $\smile$ \NC \type{\smile} +\NC $\mid$ \NC \type{\mid} +\NC $\doteq$ \NC \type{\doteq} +\NC\NR +\NC $\frown$ \NC \type{\frown} +\NC $\parallel$ \NC \type{\parallel} +\NC $\perp$ \NC \type{\perp} +\NC\NR +\stoptabulate + +\stopsection + +\startsection[title=Negated relations] + +\starttabulate[|l|l|l|l|l|l|] +\NC $\not<$ \NC \type{\not}\type{<} +\NC $\not>$ \NC \type{\not}\type{>} +\NC $\not=$ \NC \type{\not}\type{=} +\NC\NR +\NC $\not\leq$ \NC \type{\not}\type{\leq} +\NC $\not\geq$ \NC \type{\not}\type{\geq} +\NC $\not\equiv$ \NC \type{\not}\type{\equiv} +\NC\NR +\NC $\not\prec$ \NC \type{\not}\type{\prec} +\NC $\not\succ$ \NC \type{\not}\type{\succ} +\NC $\not\sim$ \NC \type{\not}\type{\sim} +\NC\NR +\NC $\not\preceq$ \NC \type{\not}\type{\preceq} +\NC $\not\succeq$ \NC \type{\not}\type{\succeq} +\NC $\not\simeq$ \NC \type{\not}\type{\simeq} +\NC\NR +\NC $\not\subset$ \NC \type{\not}\type{\subset} +\NC $\not\supset$ \NC \type{\not}\type{\supset} +\NC $\not\approx$ \NC \type{\not}\type{\approx} +\NC\NR +\NC $\not\subseteq$ \NC \type{\not}\type{\subseteq} +\NC $\not\supseteq$ \NC \type{\not}\type{\supseteq} +\NC $\not\cong$ \NC \type{\not}\type{\cong} +\NC\NR +\NC $\not\sqsubseteq$ \NC \type{\not}\type{\sqsubseteq} +\NC $\not\sqsupseteq$ \NC \type{\not}\type{\sqsupseteq} +\NC $\not\asymp$ \NC \type{\not}\type{\asymp} +\NC\NR +\stoptabulate + +\stopsection + +\startsection[title=Some arrows] + +\starttabulate[|l|l|l|l|l|l|] +\NC $\leftarrow$ \NC \type{\leftarrow} +\NC $\longleftarrow$ \NC \type{\longleftarrow} +\NC $\uparrow$ \NC \type{\uparrow} +\NC\NR +\NC $\Leftarrow$ \NC \type{\Leftarrow} +\NC $\Longleftarrow$ \NC \type{\Longleftarrow} +\NC $\Uparrow$ \NC \type{\Uparrow} +\NC\NR +\NC $\rightarrow$ \NC \type{\rightarrow} +\NC $\longrightarrow$ \NC \type{\Rightarrow} +\NC $\downarrow$ \NC \type{\downarrow} +\NC\NR +\NC $\Rightarrow$ \NC \type{\Rightarrow} +\NC $\Longrightarrow$ \NC \type{\Longrightarrow} +\NC $\Downarrow$ \NC \type{\Downarrow} +\NC\NR +\NC $\leftrightarrow$ \NC \type{\leftrightarrow} +\NC $\longleftrightarrow$ \NC \type{\longleftrightarrow} +\NC $\updownarrow$ \NC \type{\updownarrow} +\NC\NR +\NC $\Leftrightarrow$ \NC \type{\Leftrightarrow} +\NC $\Longleftrightarrow$ \NC \type{\Longleftrightarrow} +\NC $\Updownarrow$ \NC \type{\Updownarrow} +\NC\NR +\NC $\mapsto$ \NC \type{\mapsto} +\NC $\longmapsto$ \NC \type{\longmapsto} +\NC $\nearrow$ \NC \type{\nearrow} +\NC\NR +\NC $\searrow$ \NC \type{\searrow} +\NC $\swarrow$ \NC \type{\swarrow} +\NC $\nwarrow$ \NC \type{\nwarrow} +\NC\NR +\NC $\hookleftarrow$ \NC \type{\hookleftarrow} +\NC $\hookrightarrow$ \NC \type{\hookrightarrow} +\NC ~ \NC ~ +\NC\NR +\stoptabulate + +\stopsection + +\startsection[title=Alternative commands] + +\starttabulate[|l|l|l|l|l|l|l|l|l|l|] +\NC $\ne$ \NC \type{\ne} +\NC $\{$ \NC {\tttf\leftargument} +\NC $\land$ \NC \type{\land} +\NC $\to$ \NC \type{\to} +\NC $\vert$ \NC \type{\vert} +\NC\NR +\NC $\le$ \NC \type{\le} +\NC $\}$ \NC {\tttf\rightargument} +\NC $\lor$ \NC \type{\lor} +\NC $\gets$ \NC \type{\gets} +\NC $\Vert$ \NC \type{\Vert} +\NC\NR +\NC $\ge$ \NC \type{\ge} +\NC $\owns$ \NC \type{\owns} +\NC $\lnot$ \NC \type{\lnot} +\NC \NC +\NC \NC +\NC\NR +\stoptabulate + +\stopsection + +\stopchapter + +\stopcomponent + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-metapost.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-metapost.tex new file mode 100644 index 000000000..e50bed036 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-metapost.tex @@ -0,0 +1,75 @@ +\startcomponent ma-cb-en-metapost + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Graphical extension / \METAPOST] + +\index[metapost]{\METAPOST} +\index{graphical features} + +The graphical possibilities of \TEX||related macro packages are rather limited. +However, by using the graphical package \METAPOST\ of John Hobby a complete range +of graphical features has become available that may improve the look of your +documents. + +In \CONTEXT\ there is a direct link to \METAPOST\ so users can apply the features +of \METAPOST\ directly into their documents. The chapter headers and page numbers +of this manual are extended by some graphical elements that are generated by +\METAPOST. + +If you look carefully at these \METAPOST\ extensions you will notice a lot of +contextual adaptation (width and height dependend) and randomization. So you can do +things in your document that are not possible in other typesetting applications. + +A more practical example (for a mathematician at least) is drawn in \in {figure} +[fig:metapostexample]: + +\startbuffer +\startreusableMPgraphic{origin} + path pb; pb:=(5.5cm,0cm)..(10.5cm,0cm); + path qb; qb:=(8cm,-1cm)..(8cm,2.5cm); + pickup pencircle scaled 0.5mm; + drawarrow pb; + drawarrow qb; + draw thelabel.rt(btex $x$ etex,(10.6cm,0cm)); + draw thelabel.top(btex $y$ etex,(8cm,2.6cm)); + path l; l:=(5.5cm,-0.5cm)..(10.5cm,2cm); + pickup pencircle scaled 0.3mm; + draw l withcolor blue ; + pair A; A:=(6cm,-0.25cm); + pair B; B:=(9.3cm,1.4cm); + pair C; C:=(9.3cm,-0.25cm); + pickup pencircle scaled 0.15cm; + drawdot A; drawdot B; drawdot C; + draw thelabel.lrt(btex $\scriptstyle P_1(x_1,y_1)$ etex ,A); + draw thelabel.lrt(btex $\scriptstyle P_2(x_2,y_2)$ etex ,B); + draw thelabel.bot(btex $\scriptstyle P(x_2,y_1)$ etex ,C); + path s; s:=A..(9.3cm,-0.25cm); + draw s dashed (evenly scaled 1mm) withpen pencircle scaled 0.3mm; + path t; t:=B..(9.3cm,-0.25cm); + draw t dashed (evenly scaled 1mm) withpen pencircle scaled 0.3mm; +\stopreusableMPgraphic +\stopbuffer + +\getbuffer + +\placefigure + [here] + [fig:metapostexample] + {\METAPOST\ example.} + {\reuseMPgraphic{origin}} + +This example is taken from the mathematical text book {\em Algetrigulus} by +Philip Brown. All graphics in his book are made by means of \METAPOST. This +one is defined by: + +\typebuffer + +The usage and features of \METAPOST\ within \CONTEXT\ are described in the +extensive \goto {\METAFUN\ manual} [ url (manual:metafun) ]. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-modules.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-modules.tex new file mode 100644 index 000000000..4f92e8e47 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-modules.tex @@ -0,0 +1,45 @@ +\startcomponent ma-cb-en-modules + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Using modules] + +%% VZ: many new modules was added (see ma-cb-cz-modules.tex) + +\index{module} + +\Command{\tex{usemodule}} + +For reasons of efficiency \CONTEXT\ comes with a number of modules that contain +specific functionality. Loading a module is done in the set up area of your input +file by means of: + +\shortsetup{usemodule} + +When you load a module \CONTEXT\ looks for a file with the following (prefix-)name: + +\startitemize[packed] +\item m-modulename (core module) +\item p-modulename (private module) +\item s-modulename (\CONTEXT\ style file) +\item x-modulename (XML module) +\item t-modulename (third party module) +\item modulename +\stopitemize + +A few example core modules are: + +\startitemize[packed] +\item m-fields (\type{m-fields.mkiv}): for PDF forms +\item m-morse (\type{m-morse.mkvi}): for morse +\item m-spreadsheet (\type{m-spreadsheet.mkiv}): for spreadsheets +\item m-visual (\type{m-visual.mkiv}): for visual debugging +\item m-zint (\type{m-zint.mkiv}): for generating bar codes +\item s-pre-** (\type{s-pre-**}): for presentations +\stopitemize + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-pagebackgrounds.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-pagebackgrounds.tex new file mode 100644 index 000000000..ff7bf0b4d --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-pagebackgrounds.tex @@ -0,0 +1,93 @@ +\startcomponent ma-cb-en-pagebackgrounds + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Backgrounds in page areas] + +\index{page areas} +\index{background+page areas} + +\Command{\tex{setupbackgrounds}} + +The page background can be set, with: + +\shortsetup{setupbackgrounds} + +The first two bracket pairs are used to define the page areas. The last bracket +pair is used for set up. + +\startbuffer +\hbox + {\framed[width=1.5cm,frame=off] {} + \framed[width=2cm,frame=off] {left} + \framed[width=2.5cm,frame=off] {left} + \framed[width=3cm,frame=off] {text} + \framed[width=2.5cm,frame=off] {right} + \framed[width=2cm,frame=off] {right}} +\hbox + {\framed[width=1.5cm,frame=off] {} + \framed[width=2cm,frame=off] {edge} + \framed[width=2.5cm,frame=off] {margin} + \framed[width=3cm,frame=off] {} + \framed[width=2.5cm,frame=off] {margin} + \framed[width=2cm,frame=off] {edge}} +\hbox + {\framed[width=1.5cm,frame=off] {top} + \framed[width=2cm] {} + \framed[width=2.5cm] {} + \framed[width=3cm] {} + \framed[width=2.5cm] {} + \framed[width=2cm] {}} +\hbox + {\framed[width=1.5cm,frame=off] {header} + \framed[width=2cm] {} + \framed[width=2.5cm,background=screen] {} + \framed[width=3cm,background=screen] {} + \framed[width=2.5cm,background=screen] {} + \framed[width=2cm] {}} +\hbox + {\framed[width=1.5cm,frame=off,height=3cm] {text} + \framed[width=2cm,height=3cm] {} + \framed[width=2.5cm,height=3cm,background=screen]{} + \framed[width=3cm,height=3cm,background=screen] {} + \framed[width=2.5cm,height=3cm,background=screen]{} + \framed[width=2cm,height=3cm] {}} +\hbox + {\framed[width=1.5cm,frame=off] {footer} + \framed[width=2cm] {} + \framed[width=2.5cm,background=screen] {} + \framed[width=3cm,background=screen] {} + \framed[width=2.5cm,background=screen] {} + \framed[width=2cm] {}} +\hbox + {\framed[width=1.5cm,frame=off] {bottom} + \framed[width=2cm] {} + \framed[width=2.5cm] {} + \framed[width=3cm] {} + \framed[width=2.5cm] {} + \framed[width=2cm] {}} +\stopbuffer + +\placefigure + [here] + [fig:pageareas] + {The page areas defined in \type{\setupbackgrounds}.} + {\tt\getbuffer} + +If you want to have backgrounds in the gray areas of the page layout of +\in{figure}[fig:pageareas] you type: + +\startbuffer +\setupbackgrounds + [header,text,footer] + [leftmargin,text,rightmargin] + [background=screen] +\stopbuffer + +\typebuffer + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-pages.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-pages.tex new file mode 100644 index 000000000..61e2d6ce9 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-pages.tex @@ -0,0 +1,208 @@ +\startcomponent ma-cb-en-pages + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Page breaking and page numbering] + +\index{page breaking} +\index{page numbering} + +\Command{\tex{page}} +\Command{\tex{setuppagenumbering}} +\Command{\tex{setupuserpagenumber}} + +\startsection[title=Page break] + +A page can be enforced or blocked by: + +\shortsetup{page} + +The options can be stated within the brackets. The options and their meaning are +presented in \in{table}[tab:page options]. + +\placetable + [] + [tab:page options] + {Page options.} +\starttable[|l|l|] +\HL +\NC \bf Option \NC \bf Meaning \NC\SR +\HL +\NC \type{yes} \NC enforce a page \NC\FR +\NC \type{makeup} \NC enforce a page without filling \NC\MR +\NC \type{no} \NC no page \NC\MR +\NC \type{preference} \NC prefer a new page here \NC\MR +\NC \type{bigpreference} \NC great preference for a new page here \NC\MR +\NC \type{left} \NC next page is a left handside page \NC\MR +\NC \type{right} \NC next page is a right handside page \NC\MR +\NC \type{disable} \NC following commands have no effect \NC\MR +\NC \type{last} \NC add pages till even number is reached \NC\MR +\NC \type{quadruple} \NC add pages till a multiple of four is reached \NC\MR +\NC \type{even} \NC next page is even \NC\MR +\NC \type{odd} \NC next page in odd \NC\MR +\NC \type{blank} \NC no page number \NC\MR +\NC \type{empty} \NC insert an empty page \NC\MR +\NC \type{reset} \NC following commands do have effect \NC\MR +\NC \type{start} \NC from now on page commands have effect \NC\MR +\NC \type{stop} \NC from now on page commands have no effect \NC\LR +\HL +\stoptable + +\stopsection + +\startsection[title=Page numbering] + +Numbering pages is done automatically by \CONTEXT. However, numbering the pages +the way you want it may take some effort. + +A rather simple \type{\start ... \stoptext} document will be numbered from +$1 .. n$ (where $n$ is the last page). If you want your document to number +its pages alphabetical you can type: + +\startbuffer +\setupuserpagenumber + [numberconversion=character] +\stopbuffer + +\typebuffer + +in the setup area of your file. + +You can enforce a page number with: + +\starttyping +\setupuserpagenumber[number=25] +\stoptyping + +\shortsetup{setupuserpagenumber} + +The options of the \type{\setupuserpagenumber} command are given in +\in{table}[tab:user page number options]. + +\placetable + [] + [tab:user page number options] + {Page numbering: numbering options.} +\starttable[|l|l|] +\HL +\NC \bf Option \NC \bf Meaning \NC\SR +\HL +\NC \type{way} \NC how to number the document \NC\FR +\NC \type{prefix} \NC use pagenumber prefix \NC\MR +\NC \type{prefixset} \NC use defined prefixset \NC\MR +\NC \type{prefixseparatorset} \NC use defined separator \NC\MR +\NC \type{state} \NC start -- stop page numbering \NC\MR +\NC \type{number} \NC define page number \NC\MR +\NC \type{numberconversion} \NC convert page number \NC\MR +\NC \type{numberconversionset} \NC used defined conversion set \NC\LR +\HL +\stoptable + +The \type{prefixset}, \type{prefixseparatorset} and the \type{numberconversionset} +options are defined with the \type{\defineprefixset}, \type{\defineseparatorset} +and \type{\defineconversionset} respectively. + +This manual uses the \CONTEXT\ standard document section blocks: frontpart, +bodymatter and appendices. These section blocks are numbered with roman +characters, numeral digits and characters respectively. + +\startbuffer +\defineconversionset + [frontpart:pagenumber][][romannumerals] + +\defineconversionset + [bodypart:pagenumber] [][numbers] + +\defineconversionset + [appendix:pagenumber] [][Characters] +\stopbuffer + +\typebuffer + +At the start of each section block the number is reset to i, 1 and A respectively. + +The same effect would have been obntained with: + +\startbuffer +\startsectionblockenvironment[frontpart] + \setupuserpagenumber[numberconversion=romannumerals] +\stopsectionblockenvironment +\stopbuffer + +\typebuffer + +Page numbering and the location of the page numbers can be set up with: + +\shortsetup{setuppagenumbering} + +The options of this command are shown in \in{table}[tab:page numbering options]: + +\placetable + [] + [tab:page numbering options] + {Page numbering: layout options.} +\starttable[|l|l|] +\HL +\NC \bf Option \NC \bf Meaning \NC\SR +\HL +\NC \type{alternative} \NC page layout: single or double sided \NC\MR +\NC \type{location} \NC location of page number on page \NC\MR +\NC \type{width} \NC width of pagen umber \NC\MR +\NC \type{left} \NC text left of page number \NC\MR +\NC \type{right} \NC text right of page number \NC\MR +\NC \type{page} \NC \unknown \NC\MR +\NC \type{state} \NC start -- stop page numbering \NC\MR +\NC \type{command} \NC invoke command \NC\MR +\NC \type{style} \NC set character style \NC\MR +\NC \type{color} \NC set color \NC\LR +\HL +\stoptable + +Note that this is also the command that indicates that your document is single or +double sided which has an effect on the left-right page layout. + +\startbuffer +\setuppagenumbering + [alternative=doublesided] +\stopbuffer + +\typebuffer + +In this manual page numbering is set up with: + +\starttyping +\setuppagenumbering + [location={footer,middle}, + command=\NummerCommando] +\stoptyping + +The \type{\NummerCommando} uses \METAPOST\ to draw a unique random image around +each page number. + +You can recal a page number with \type{\userpagenumber}. If you set up your headertext +with: + +\startbuffer + \setupheadertexts + [Page \userpagenumber\ of \lastuserpagenumber] +\stopbuffer + +\typebuffer + +You would get a header with the actual page number and the total of pages (in that +section block). + +The actual page number and the real page number may differ since there may be pages +or sections that in your document that are not numbered. If you feel the need to +display the real page number there is the command \type{\realpagenumber}. + +Please refer to the \goto {\CONTEXTWIKI} [ +url(http://wiki.contextgarden.net/Command/setupuserpagenumber) ] for more +details. + +\stopchapter + +\stopcomponent + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-paragraphs.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-paragraphs.tex new file mode 100644 index 000000000..668b6ab01 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-paragraphs.tex @@ -0,0 +1,280 @@ +\startcomponent ma-cb-en-paragraphs + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Paragraph spacing] + +\startsection[title=Introduction] + +\index{paragraph} + +\Command{\tex{par}} +\Command{\tex{paragraph}} + +In \TEX\ and \CONTEXT\ the most important unit of text is the paragraph. You can +start a new paragraph by: + +\startitemize[packed] +\item an empty line +\item the \TEX\ command \type{\par} +\stopitemize + +In your \ASCII\ input file you should use empty lines as paragraph separators. +This will lead to a readable, clearly structured and well organized file and will +prevent mistakes. + +In situations where a command has to be closed explicitly you should use +\type{\par}. + +\startbuffer +During one of the wars Hasselt lay under siege. After some +time the city was famine stricken, everything edible was +eaten. Except for one cow. The cow was kept alive and +treated very well. \par +Once a day the citizens of Hasselt took the cow for a walk +on the ramparts. The besiegers saw the well fed cow and +became very discouraged. They broke up their camps and +Hasselt was saved. \par +In the Hoogstraat in Hasselt there is a stone tablet with a +representation of the cow that commemorates the siege and +the shrewdness of the citizens of Hasselt. +\stopbuffer + +\typebuffer + +This could also be typed without \type{\par}s and a few empty lines. + +\startbuffer +During one of the wars Hasselt lay under siege. After some +time the city was famine stricken, everything edible was +eaten. Except for one cow. The cow was kept alive and +treated very well. + +Once a day the citizens of Hasselt took the cow for a walk +on the ramparts. The besiegers saw the well fed cow and +became very discouraged. They broke up their camps and +Hasselt was saved. + +In the Hoogstraat in Hasselt there is a stone tablet with a +representation of the cow that commemorates the siege and +the wisdom of the citizens of Hasselt. +\stopbuffer + +\typebuffer + +\stopsection + +\startsection[title=Inter paragraph spacing] + +\index{inter paragraph spacing} + +\Command{\tex{setupwhitespace}} +\Command{\tex{nowhitespace}} +\Command{\tex{whitespace}} +\Command{\tex{startlinecorrection}} % VZ 2006-11-15 setup->start +\Command{\tex{blank}} +\Command{\tex{setupblank}} +\Command{\tex{startpacked}} +\Command{\tex{startunpacked}} + +The vertical spacing between paragraphs can be specified by: + +\shortsetup{setupwhitespace} + +This document is produced with \type{\setupwhitespace[medium]}. + +When inter paragraph spacing is specified there are two commands available that +are seldom needed: + +\starttyping +\nowhitespace +\whitespace +\stoptyping + +When a paragraph consists of a horizontal line or a framed text like this: + +\startbuffer +\framed{Ridderstraat 27, 8061GH Hasselt} +\stopbuffer + +\getbuffer + +Sometimes spacing is suboptimal. For that purpose you could carry out a +correction with: + +\shortsetup{startlinecorrection} + +So if you would type: + +\startbuffer +\startlinecorrection +\framed{Ridderstraat 27, 8061GH Hasselt} +\stoplinecorrection +\stopbuffer + +\typebuffer + +you will get a better output. Only use these commands if really needed! + +\getbuffer + +Another command to deal with vertical spacing is: + +\shortsetup{blank} + +The bracket pair is optional and within the bracket pair you can type the amount +of spacing. Keywords like \type{small}, \type{medium} and \type{big} are related +to the fontsize. + +\startbuffer +In official writings Hasselt always has the affix Ov. This is an +abbrevation for the province of {\em Overijssel}. +\blank[2*big] +The funny thing is that there is no other Hasselt in the Netherlands. +So it is redundant. +\blank +The affix is a leftover from the times that the Netherlands and +Belgium were one country under the reign of King Philip II of Spain. +\blank[2*big] +Hasselt in Belgium lies in the province of Limburg. One wonders if +the Belgian people write Hasselt (Li) on their letters. +\stopbuffer + +\typebuffer + +The command \type{\blank} without the bracket pair is the default space. + +The example would become: + +\getbuffer + +The default spacing can be set up with: + +\shortsetup{setupblank} + +If you want to surpress vertical spacing you can use: + +\shortsetup{startpacked} + +In this manual the whitespace is set at \type{medium}. In the next situation this +set up is ignored and the lines are packed. + +\startbuffer +\startpacked +Hasselt (Ov) lies in Overijssel. + +Hasselt (Li) lies in Limburg. + +Watch out: we talk about Limburg in Belgium. There is +also a Dutch Limburg. +\stoppacked +\stopbuffer + +\typebuffer + +This will become: + +\getbuffer + +It is not hard to imagine why there is also: + +\shortsetup{startunpacked} + +You can force vertical space with \type{\godown}. The distance is specified +within the brackets. + +\shortsetup{godown} + +Try not to use this command. It is always better use the \type{\setup...} commands +to setup your spacing model. + +\stopsection + +\startsection[title=Whitespace before and after text components] + +Most text components that are coded with \CONTEXT\ have a \type{\setup...} command +with which you can define the whitespace before and after that component. + +\starttyping +\setupitemize + [before=,after=] + +\setuphead + [chapter] + [before=,after=] + +\setupframedtexts + [before=,after=] +\stoptyping + +The use of the \type{\setup...} commands prevents you from having to code +whitespaces throughout your \TEX\ document. This would lead to unreadable sources +and inconsistent use of whitepaces. + +\stopsection + +\startsection[title=Skipping space] + +\Command{\tex{hskip}} +\Command{\tex{vskip}} + +You can introduce horizontal and vertical space with \type{\hskip} and +\type{\vskip} commands. + +Try to avoid these commands in your text. It will probably lead to inconsistent +spacing. + +\stopsection + +\startsection[title=Indentation] + +\index{indentation} +\index{paragraph+indentation} + +\Command{\tex{indenting}} +\Command{\tex{noindenting}} +\Command{\tex{setupindenting}} + +You can set up the amount of the indentation with: + +\shortsetup{setupindenting} + +A reasonable indentation is achieved by: + +\starttyping +\setupindenting[yes,] +\stoptyping + +This will lead to indented paragraphs. By default, indentation after white space +(as issued by \type {\blank}) is suppressed. + +You can locally influence the indentation state by using: + +\shortsetup{indenting} + +When for instance you say \type {never}, from that moment on indentation will be +surpressed. Saying \type {none}, only influences the next paragraph. + +If you choose to use indentations, and at a certain place you explicitly {\em do +not} want to indent, you can also say: + +\starttyping +\noindenting +\stoptyping + +In some \type{\setup...} commands you can set the parameter \type{indent=yes}. This means +that the paragraph that follows the textcomponent will indent: + +\startbuffer +\setupitemize[indentnext=yes] +\stopbuffer + +\typebuffer + +\stopsection + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-presentations.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-presentations.tex new file mode 100644 index 000000000..623ba9490 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-presentations.tex @@ -0,0 +1,38 @@ +\startcomponent ma-cb-en-presentations + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Presentations,reference=presentations] + +\index{presentation} + +You can use \CONTEXT\ for making your own presentations. A \CONTEXT\ presentation +is an interactive PDF document with a screen layout. Often presentations are good +examples of the cooperation between \CONTEXT\ and \METAPOST. + +\CONTEXT\ comes with a number ready-to-use presentations. A presentation is a +module with the prefix \type{s-} and that you can load with the \type{\usemodule} +command. + +If you want to use an already existing presentation the best way to proceed is: + +\startitemize[packed] +\item goto \type{../your-contextdir/tex/texmf-context/tex/context/base} in your text editor +\item open a presentation: for example \type{s-pre-05.tex} +\item goto the end of the file and study the commands between + the \type{\start...\stoptext} pair +\item copy the commands into your own presentation file +\item invoke the presentation with \type{\usemodule[s][pre-05]} in de setup + area of your presentation file +\item process the file to view the result +\item edit the content of your presentation +\stopitemize + +A stepwise setup of a presentation is given at the +\goto{\CONTEXTWIKI}[ url (http://wiki.contextgarden.net/Presentations) ]. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-processingfiles.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-processingfiles.tex new file mode 100644 index 000000000..1ceabfeb1 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-processingfiles.tex @@ -0,0 +1,44 @@ +\startcomponent ma-cb-en-processingfiles + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=The \type{context} command,reference=contextcommand] + +\index{\type{context} (command)} +\index{\type{mtxrun} (command)} +\index{processing TeX file} + +You can process a \TEX\ file or run \CONTEXT\ with the command \type{context} +that you can type at your console: + +\starttyping +context myfile +\stoptyping + +\CONTEXT\ will make multiple runs to get the layout, references, lists and +pagenumbering straight. You can see those runs echoed on your screen and listed +in the \type{myfile.log} file. + +You can add parameters to give the command \type{context} additional +tasks while processing the file. If you want start up \READER\ automatically +you can type: + +\starttyping +context --autopdf myfile +\stoptyping + +A full overview of the parameters is given when you type: + +\starttyping +context --help +\stoptyping + +Please refer to the manual \goto{luatools, mtxrun, context}[ url (manual:tools) ] +for more information on running \CONTEXT. + +\stopchapter + + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-references.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-references.tex new file mode 100644 index 000000000..bc758e521 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-references.tex @@ -0,0 +1,148 @@ +\startcomponent ma-cb-en-references + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Refering to text elements] + +\index{refering} +\index{label} + +\Command{\tex{in}} +\Command{\tex{at}} +\Command{\tex{pagereference}} + +To disclose your document for your readers you can use the table of contents and +the register. However, it is not uncommon to refer to specific text elements like +formulas, tables, images and sections to enhance readability. + +For refering from one location in a document to another you can use the command: + +\shortsetup{in} + +The curly braces contain text and the brackets contain a logical label. If you have +written a chapter header like this: + +\starttyping +\startchapter[title=Hotels in Hasselt,reference=hotel] + ... +\stopchapter +\stoptyping + +then you can refer to this chapter with: + +\starttyping +\in{chapter}[hotel] +\stoptyping + +After processing the chapter number is available and the reference could look +something like: {\em chapter 23}. You can use \type{\in} for any references to +text elements like chapters, sections, figures, tables, formulas etc. + +Another example: + +\startbuffer +There are a number of things you can do in Hasselt: + +\startitemize[n,packed] +\item swimming +\item sailing +\item[hiking] hiking +\item biking +\stopitemize + +An activity like \in{activity}[hiking] described on \at{page}[hiking] +is very tiring. +\stopbuffer + +\typebuffer + +This would look like this: + +\getbuffer + +As you can see, it is also possible to refer to pages. This is done with: + +\shortsetup{at} + +For example with: + +\starttyping +\at{page}[hiking] +\stoptyping + +This command can be used in combination with: + +\shortsetup{pagereference} + +and + +\shortsetup{textreference} + +If you want to refer to the chapter {\em Hotels in Hasselt} you could type: + +\startbuffer +Look in \in{chapter}[hotel] on \at{page}[hotel] for a complete +overview of accomodations in \pagereference[accomodation]Hasselt. +\stopbuffer + +\typebuffer + +A chapter number and a page number will be generated when processing the input +file. On another spot in the document you can refer to \type{accomodation} with +\type{\at{page}[accomodation]}. + +You can also define a set of labels separated by commas. + +\startbuffer +\placefigure + [here] + [fig:canals,fig:boats] + {A characteristic picture of Hasselt.} + {\externalfigure[ma-cb-08][width=10cm]} + +There are many canals in Hasselt (see \in{figure}[fig:canals]). +. +. +. +Boats can be moored in the canals of Hasselt (see +\in{figure}[fig:boats]). +\stopbuffer + +\typebuffer + +This might look like this: + +\getbuffer + +You can also refer to a title of a chapter or section or even a caption of an +image. This is done with: + +\shortsetup{about} + +This: + +\startbuffer +The caption of \in{figure}[fig:canals] is {\em \about[fig:canals]}. +\stopbuffer + +\typebuffer + +Becomes: + +\getbuffer + +With the command: + +\starttyping +\setupinteraction[state=start] +\stoptyping + +all references become active links. See \in{chapter}[interactivity] for more +information on this subject. + +\stopchapter + +\stopcomponent + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-registers.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-registers.tex new file mode 100644 index 000000000..315e2bfa4 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-registers.tex @@ -0,0 +1,83 @@ +\startcomponent ma-cb-en-registers + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Registers] + +\index{register} + +\Command{\tex{index}} +\Command{\tex{placeindex}} +\Command{\tex{completeindex}} +\Command{\tex{defineregister}} +\Command{\tex{placeregister}} +\Command{\tex{completeregister}} +\Command{\tex{setupregister}} + +It is possible to generate one or more registers. By default the command +\type{\index} is available. If you want to add a word to the index you type: + +\starttyping +\index{town hall} +\stoptyping + +The word {\em town hall} will appear as an index entry in the sorted register. +Sometimes the index word does not appear in normal alphabetic order. For example, +entries such as symbols have to provide extra sorting information in order to +produce a correct alphabetical list: + +\starttyping +\index[minus]{$-$} +\stoptyping + +Sometimes you have sub- or sub sub entries. These can be defined as follows: + +\starttyping +\index{town hall+location} +\index{town hall+architecture} +\stoptyping + +You can generate your register with the command: + +\starttyping +\placeindex +\stoptyping + +or + +\starttyping +\completeindex +\stoptyping + +The command \type{\index} is a predefined \CONTEXT\ command, but of course you +can also define your own registers. + +\shortsetup{defineregister} + +For example if you want to make a new register based on the streets in Hasselt +you could type: + +\starttyping +\defineregister[street] +\stoptyping + +Now a new register command \type{\street} is available. Now +\type{\street{Ridderstraat}} is a new index entry. To produce a list of entries +you could now use: + +\starttyping +\placeregister[street] +\placestreet +\completestreet +\stoptyping + +You can alter the layout of the registers with: + +\shortsetup{setupregister} + +\stopchapter + +\stopcomponent + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-runtimefiles.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-runtimefiles.tex new file mode 100644 index 000000000..d72b536a5 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-runtimefiles.tex @@ -0,0 +1,41 @@ +\startcomponent ma-cb-en-runtimefiles + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Auxilliary files,reference=runtimefiles] + +\index[tuc]{{\tt tuc}--file} +\index{auxilliary files} + +\CONTEXT\ will produce a number of auxilliary files during processing. If your +input file is called \type{myfile.tex} the following files may appear on your +working directory. + +\index[tuc]{{\tt tuc}--file} +\index{auxilliary files} + +\starttabulate[|l|l|l|] +\HL +\NC \darkgray \bf \CONTEXT\ MkII \NC \bf \CONTEXT\ MkIV \NC \bf Meaning \NC\NR +\HL +\NC \darkgray \tt myfile.tex \NC \tt myfile.tex \NC your text file \NC\NR +\HL +\NC \darkgray \tt myfile.log \NC \tt myfile.log \NC log information \NC\NR +\NC \darkgray \tt myfile.tuo \NC \tt myfile.tuc \NC output information \NC\NR +\NC \darkgray \tt myfile.tui \NC \NC \darkgray input information \NC\NR +\NC \darkgray \tt myfile.tmp \NC \NC \darkgray temporary information \NC\NR +\NC \darkgray \tt mpgraph.mp \NC \NC \darkgray \METAPOST\ information \NC\NR +\HL +\NC \darkgray \tt myfile.pdf \NC \tt myfile.pdf \NC result file \NC\NR +\HL +\stoptabulate + +The \type{myfile.tuc} file contains information about registers, lists and +references which will be used when necessary. The \type{myfile.log} +can be viewed in case there are problems during processing. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-setupcommands.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-setupcommands.tex new file mode 100644 index 000000000..2f087ea8d --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-setupcommands.tex @@ -0,0 +1,54 @@ +\startcomponent ma-cb-en-setupcommands + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Setup commands] + +\index{set up} +\index{layout} + +Global commands are placed in the setup area of your input file, before +\type{\starttext}. In \in{appendix}[commandsetups] there is a complete overview of the +available commands and their parameters. + +The set up commands all have the same structure. They look something like: + +\shortsetup{setupparagraphs} + +A set up command consists of a more or less logical name and a number of bracket +pairs. Bracket pairs may be optional and in that case the \type{[]} are typeset +slanted {\tt \sl []}. In the definition the bracket pairs may contain: + +\starttyping +\setupacommand[.1.][.2.][..,..=..,..] +\stoptyping + +The commas indicate that a list of parameters can be enclosed. In the options +list following the definition, the \type{.1.} and \type{.2.} show the possible +options that can be set in the first and second bracket pair respectively. The +parameters and their possible values are placed in the third bracket pair. + +The default options and parameter values are underlined. + +Furthermore you will notice that some values are typeset in a slanted way: {\sl +section}, {\sl name}, {\sl dimension}, {\sl number}, {\sl command} and {\sl +text}. This indicates that you can set the value yourself. + +\starttabulate[|S||] +\NC section \NC a section name like chapter, section, subsection etc. \NC\NR +\NC name \NC an identifier (logical name) \NC\NR +\NC dimension \NC a dimension with a unit in \type{cm}, \type{pt}, + \type{em}, \type{ex}, \type{sp} or \type{in} \NC\NR +\NC number \NC an integer \NC\NR +\NC command \NC a command \NC\NR +\NC text \NC text \NC\NR +\stoptabulate + +In the \goto {Quick Reference} [ url (manual:qr-en) ] +manual you can find a complete overview of the commands and their parameters. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-sortedlists.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-sortedlists.tex new file mode 100644 index 000000000..c3b47ea27 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-sortedlists.tex @@ -0,0 +1,71 @@ +\startcomponent ma-cb-en-sortedlists + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=synonyms,title=Sorted lists] + +\index{sorted lists} + +\Command{\tex{definesorting}} +\Command{\tex{setupsorting}} +\Command{\tex{sort}} +\Command{\tex{placelistofsorts}} +\Command{\tex{completelistofsorts}} + +If you want to create a sorted list you can use: + +\shortsetup{definesorting} + +For example: + +\startbuffer +\define[1]\street{#1\Street{#1}} +\definesorting[Street][Streets] +\setupsorting[Street][criterium=all] + +When you walk in the \street{Eikenlaan} you will cross the +\street{Vechtlaan} and \street{Gasthuisstraat}. Go left into the +\street{Gasthuisstraat} and take another left on the +\street{Heerengracht}. You walk along the canal to the +\street{Ridderstraat}, there you turn right. Cross the canal and +turn left to the \street{Julianakade}. There you can enjoy the +view over the Zwartewater. + +So the streets you visited are: + +\placelistofStreets +\stopbuffer + +\typebuffer + +This will become: + +\getbuffer + +Note that the Gasthuisstraat appears only once in the list. + +The predefined \type{\logo} command is used for the consistent use of text logos. + +When you define: +\startbuffer +\logo [HSTEX] {Hassel\TeX} +\stopbuffer + +\getbuffer\typebuffer + +You can use that logo througout your text. + +\startbuffer +How would you call a \TEX\ based macropackage when you work +in Hasselt? \HSTEX? +\stopbuffer + +\typebuffer + +\getbuffer + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-specialcharacters.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-specialcharacters.tex new file mode 100644 index 000000000..619ccf3a6 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-specialcharacters.tex @@ -0,0 +1,60 @@ +\startcomponent ma-cb-en-specialcharacters + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=special chars,title=Special characters] + +\index{special characters} + +You have seen that \CONTEXT\ commands are preceded by a \tex{} (backslash). This +means that \tex{} has a special meaning to \CONTEXT. Aside from \tex{} there are +other characters that need special attention when you want them to appear in +verbatim mode or in text mode. \in{Table}[tab:specchars] gives an overview of +these special characters and what you have to type to produce them. + +\placetable[here,force][tab:specchars] + {Special characters (1).} + {\starttable[|c|l|c|c|c|c|] + \HL + \NC \use2 \JustCenter{\bf Special character} \NC \use2 \bf Verbatim \NC \use2 \bf Text \NC\FR + \NC \bf Character \NC \bf Name \NC \bf Type \NC \bf Generates \NC \bf Type\NC \bf Generates \NC\LR + \HL + \NC \type{#} \NC hashtag \NC \type{\type{#}} \NC \type{#} \VL \type{\#} \NC \# \NC\FR + \NC \type{$} \NC dollar \NC \type{\type{$}} \NC \type{$} \VL \type{\$} \NC \$ \NC\MR + \NC \type{&} \NC ampersand \NC \type{\type{&}} \NC \type{&} \VL \type{\&} \NC \& \NC\MR + \NC \type{%} \NC percent \NC \type{\type{%}} \NC \type{%} \VL \type{\%} \NC \% \NC\MR + \NC \type{\} \NC backslash \NC \type{\type{\}} \NC \type{\} \VL \type{\backslash} \NC \backslash \NC\MR + \NC \type+{+ \NC right curly brace \NC \type-\type+{+- \NC \type+{+ \VL \type+\{+ \NC \{ \NC\MR + \NC \type+}+ \NC left curly brace \NC \type-\type+}+- \NC \type+}+ \VL \type+\}+ \NC \} \NC\MR + \NC \type{|} \NC vertical bar \NC \type{\type{|}} \NC \type{|} \VL \type{\|} \NC \| \NC\MR + \NC \type{_} \NC underscore \NC \type{\type{_}} \NC \type{_} \VL \type{\_} \NC \_ \NC\MR + \NC \type{~} \NC tilde \NC \type{\type{~}} \NC \type{~} \VL \type{\lettertilde} \NC \lettertilde \NC\MR + \NC \type{^} \NC caret \NC \type{\type{^}} \NC \type{^} \VL \type{\letterhat} \NC \letterhat \NC\LR + \HL + \stoptable} + +Other special characters have a meaning in typesetting mathematical expressions +and some can be used in math mode only (see \in{chapter}[formulas]). + +\placetable + [here,force] + [tab:special chars] + {Special characters (2).} + {\starttable[|c|c|c|c|c|] + \HL + \NC \bf \LOW{Special character} \NC \use2 \bf Verbatim \NC \use2 \bf Text \NC\FR + \NC \NC \bf Type \NC \bf Generates \NC \bf Type \NC \bf Generates \NC\LR + \HL + \NC \type{+} \NC \type{\type{+}} \NC \type{+} \VL \type{$+$} \NC $+$ \NC\FR + \NC \type{-} \NC \type{\type{-}} \NC \type{-} \VL \type{$-$} \NC $-$ \NC\MR + \NC \type{=} \NC \type{\type{=}} \NC \type{=} \VL \type{$=$} \NC $=$ \NC\MR + \NC \type{<} \NC \type{\type{<}} \NC \type{<} \VL \type{$<$} \NC $<$ \NC\MR + \NC \type{>} \NC \type{\type{>}} \NC \type{>} \VL \type{$>$} \NC $>$ \NC\LR + \HL + \stoptable} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-structure.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-structure.tex new file mode 100644 index 000000000..4001a6831 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-structure.tex @@ -0,0 +1,133 @@ +\startcomponent ma-cb-en-structure + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Defining a document] + +Every document is started with \type{\starttext} and closed with +\type{\stoptext}. All textual input is placed between these two commands and +\CONTEXT\ will only process that information. + +Setup information is placed in the set up area just before \type{\starttext}. + +\setuptyping + [escape=yes] + +\definestartstop + [comment][style={\rm}] + +\starttyping + +\setupbodyfont[12pt] /BTEX \comment{setuparea of document} /ETEX + +\starttext +This is a one line document. /BTEX \comment{your text} /ETEX +\stoptext +\stoptyping + +The definition of a (very simple) book could look something like this: + +\startbuffer +\starttext + +\startstandardmakeup + \midaligned{From Hasselt to America} + \midaligned{by} + \midaligned{J. Jonker and C. van Marle} +\stopstandardmakeup + +\title{Foreword} + +\chapter{Introduction} + +\chapter{The Rensselaer family} + +\chapter{The Lansing family} + +\chapter{The Cuyler family} + +\chapter{Appendix: Photos} + +\stoptext +\stopbuffer + +\typebuffer + +\CONTEXT\ comes with a predefined overall structure in which the document is +divided into four main document divisions:\footnote{Here we try to avoid the +word {\em section}.} + +\startitemize[n,packed] +\item front matter +\item body matter +\item appendices +\item back matter +\stopitemize + +The document divisions are defined with: + +\starttyping +\startfrontmatter ... \stopfrontmatter +\startbodymatter ... \stopbodymatter +\startappendices ... \stopappendices +\startbackmatter ... \stopbackmatter +\stoptyping + +The chapters in your book can be divided over these divisions. + +\startbuffer +\starttext + +\startstandardmakeup + \midaligned{From Hasselt to America} + \midaligned{by} + \midaligned{J. Jonker and C. van Marle} +\stopstandardmakeup + +\startfrontmatter + + \title{Preface} + + \chapter{Introduction} + +\stopfrontmatter + +\startbodymatter + + \chapter{The Rensselaer family} + + \chapter{The Lansing family} + + \chapter{The Cuyler family} + +\stopbodymatter + +\startappendices + + \chapter{Photos} + +\stopappendices + +\stoptext +\stopbuffer + +\typebuffer + +In the front matter as well as back matter the command \type{\chapter} +produces an un-numbered header in the table of contents. The front matter is mostly +used for the table of contents, the list of figures and tables, the preface, the +acknowledgements etc. It often comes with a roman page numbering. + +The appendices division is used for (indeed) appendices. Headers may be typeset in +a different way; for example, \type{\chapter} may be numbered alphabetically. + +The style of each document division can be set up with: + +\shortsetup{setupsectionblock} + +\stopchapter + +\stopcomponent + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-support.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-support.tex new file mode 100644 index 000000000..cc6b5819f --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-support.tex @@ -0,0 +1,17 @@ +\startcomponent ma-cb-en-support + +\project ma-cb + +% only text + +For your Questions and Answers you can subscribe to the \goto {\CONTEXT\ mailing +list} [ url(list:context) ]. + +Visit the \goto {Pragma ADE website} [ url +(http://www.pragma-ade.com/overview.htm) ] for extensive information about +\CONTEXT. + +Goto the \goto {ConTeXt Garden} [ url (http://wiki.contextgarden.net) ] to find +all kinds of practical information on how to use \CONTEXT. + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-synonyms.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-synonyms.tex new file mode 100644 index 000000000..8d921d5b0 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-synonyms.tex @@ -0,0 +1,89 @@ +\startcomponent ma-cb-en-synonyms + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=synonyms,title=Synonyms] + +\index{synonyms} + +\Command{\tex{definesynonyms}} +\Command{\tex{setupsynonyms}} +\Command{\tex{abbreviation}} +\Command{\tex{infull}} +\Command{\tex{loadabbreviations}} +\Command{\tex{placelistofabbreviations}} +\Command{\tex{completelistofabbreviations}} + +In many documents people want to use specific words consistently throughout the +document. To enforce consistency the command below is available. + +\shortsetup{definesynonyms} + +The first bracket pair contains the singular form of the synonym, and the second +contains the plural form. The third bracket pair contains a command. + +For example the command \type{\abbreviation} is defined by: + +\starttyping +\definesynonyms[abbreviation][abbreviations][\infull] +\setupsynonyms[style=cap] +\stoptyping + +Now the command \type{\abbreviation} is available and can be used to state your +abbreviations: + +\starttyping +\abbreviation{ANWB}{Dutch Automobile Association} +\abbreviation{VVV}{Bureau of Tourist Information} +\abbreviation{NS}{Dutch Railways} +\stoptyping + +\abbreviation{VVV}{Bureau of Tourist Information} + +If you would type: + +\startbuffer +The Dutch \VVV\ (\infull{VVV}) can provide you with the tourist +information on Hasselt. +\stopbuffer + +\typebuffer + +You would obtain something like this: + +\getbuffer + +The list of synonyms or abbreviations is best defined in the set up area of your +input file for maintenance purposes. You can also store this kind of information +in an external file, and load the file (e.g. \type{abbrev.tex}) with: + +\starttyping +\input abbrev.tex +\stoptyping + +If you want to put a list of the abbreviations used in your document you can +type: + +\starttyping +\placelistofabbreviations +\stoptyping + +or + +\starttyping +\completelistofabbreviations +\stoptyping + +A complete and sorted list with used abbreviations and their meaning is produced. + +The typesetting of synonynms can be influenced with: + +\starttyping +\setupsynonyms +\stoptyping + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-tables.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-tables.tex new file mode 100644 index 000000000..39ce0cb4a --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-tables.tex @@ -0,0 +1,385 @@ +\startcomponent ma-cb-en-tables + +% AFO: the \start ... \stoplinetable mechanism is not stable enough + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=tables,title=Tables] + +\index{tables} +\index{natural tables} +\index{extreme tables} +\index{floating blocks} + +\Command{\tex{placetable}} +\Command{\tex{setuptables}} +\Command{\tex{starttable}} +\Command{\tex{startcombination}} +\Command{\tex{setupfloats}} +\Command{\tex{setupcaptions}} +\Command{\tex{NR}} +\Command{\tex{FR}} +\Command{\tex{LR}} +\Command{\tex{MR}} +\Command{\tex{SR}} +\Command{\tex{VL}} +\Command{\tex{NC}} +\Command{\tex{HL}} +\Command{\tex{DL}} +\Command{\tex{DC}} +\Command{\tex{DR}} +\Command{\tex{LOW}} +\Command{\tex{TWO}} +\Command{\tex{THREE}} +\Command{\tex{bTABLE}} +\Command{\tex{eTABLE}} +\Command{\tex{bTR}} +\Command{\tex{eTR}} +\Command{\tex{bTD}} +\Command{\tex{eTD}} +\Command{\tex{setupTABLE}} +\Command{\tex{startxtable}} +\Command{\tex{stopxtable}} +\Command{\tex{startxcell}} +\Command{\tex{startxrow}} +\Command{\tex{setupxtable}} + +There are a number of ways to define a table: + +\startitemize[packed] +\item the \type{\start ... \stoptable} mechanism, based on the work of M. Wichura +\item the \type{\bTABLE ... \eTABLE} mechanism (natural tables) +\item the \type{\start ... \stopxtable} mechanism (extreme tables) +\stopitemize + +In the next sections we describe the principles of the three table mechanisms. + +\startsection[title=Simple tables] + +For defining the table you use: + +\shortsetup{starttable} + +The definition of a table could look something like this: + +\startbuffer +\placetable + [here] + [tab:ships] + {Ships that moored at Hasselt.} + {\starttable[|c|c|] + \HL + \NC \bf Year \NC \bf Number of ships \NC\SR + \HL + \NC 1645 \NC 450 \NC\FR + \NC 1671 \NC 480 \NC\MR + \NC 1676 \NC 500 \NC\MR + \NC 1695 \NC 930 \NC\LR + \HL + \stoptable} +\stopbuffer + +\typebuffer + +This table is typeset as \in{table}[tab:ships]. + +\getbuffer + +Although this table mechanism is still available and supported in \CONTEXT\ +it is better to use one of the other mechanisms. + +\stopsection + +\startsection[title=Natural tables] + +The natural table mechanism (\type{\bTABLE ... \eTABLE}) is developed for more +complex tables and has features of the general interface of \CONTEXT. + +\startbuffer +\placetable + [here,force] + [tab:votedivision] + {Division of votes over political parties.} + {\bTABLE[align=middle,offset=4pt] + \bTABLEhead + \bTR[width=6cm] \bTD [nc=5] Elections City Council \eTD \eTR + \eTABLEhead + \bTABLEbody + \bTR \bTD[nr=2,align={right,lohi}] Party \eTD + \bTD[nc=3,foregroundstyle=bold] Districts \eTD + \bTD[nr=2,align={middle,lohi}] Total \eTD \eTR + \bTR \bTD 1 \eTD \bTD 2 \eTD \bTD 3 \eTD \eTR + \bTR \bTD[align=right] PvdA \eTD + \bTD 351 \eTD \bTD 433 \eTD \bTD 459 \eTD \bTD 1243 \eTD \eTR + \bTR \bTD[align=right] CDA \eTD + \bTD 346 \eTD \bTD 350 \eTD \bTD 285 \eTD \bTD ~981 \eTD \eTR + \bTR \bTD[align=right] VVD \eTD + \bTD 140 \eTD + \bTD[offset=2pt,background=color, + backgroundcolor=red,foregroundcolor=white, + foregroundstyle=bold,framecolor=blue, + rulethickness=2pt] 113 \eTD + \bTD 132 \eTD \bTD ~385 \eTD \eTR + \bTR \bTD[align=right] SGP \eTD + \bTD 348 \eTD \bTD 261 \eTD \bTD 158 \eTD \bTD ~767 \eTD \eTR + \bTR \bTD[align=right] GPV \eTD + \bTD 117 \eTD \bTD 192 \eTD \bTD 291 \eTD \bTD ~600 \eTD \eTR + \eTABLEbody + \eTABLE} +\stopbuffer + +\start +\switchtobodyfont[8pt] +\typebuffer +\stop + +In the last column a \type{~} is used to simulate a four digit number. The +\type{~} has the width of a digit. + +\start +\getbuffer +\stop + +The setup of the table is placed between the square brackets \type{[ ]}. To keep +the data in the table more readable you can set up the table with the \type +{\setupTABLE} command. + +\shortsetup{bTABLE} + +\startbuffer +\setupTABLE[row][align=middle,offset=4pt] +\setupTABLE[1][1][width=6cm] +\setupTABLE[1][2][align={right,lohi}] +\setupTABLE[5][2][align={right,lohi}] +\setupTABLE[2][2][foregroundstyle=bold] +\setupTABLE[1][4,5,6,7,8][align=right] +\setupTABLE[3][6][offset=2pt,background=color, + backgroundcolor=red,foregroundcolor=white, + foregroundstyle=bold,framecolor=blue, + rulethickness=2pt] + +\bTABLE + \bTABLEhead + \bTR \bTD[nc=5] Elections City Council \eTD \eTR + \bTR \bTD[nr=2] Party \eTD \bTD[nc=3] Districts \eTD \bTD[nr=2] Total \eTD \eTR + \bTR \bTD 1 \eTD \bTD 2 \eTD \bTD 3 \eTD \eTR + \eTABLEhead + \bTABLEbody + \bTR \bTD PvdA \eTD \bTD 351 \eTD \bTD 433 \eTD \bTD 459 \eTD \bTD 1243 \eTD \eTR + \bTR \bTD CDA \eTD \bTD 346 \eTD \bTD 350 \eTD \bTD 285 \eTD \bTD ~981 \eTD \eTR + \bTR \bTD VVD \eTD \bTD 140 \eTD \bTD 113 \eTD \bTD 132 \eTD \bTD ~385 \eTD \eTR + \bTR \bTD SGP \eTD \bTD 348 \eTD \bTD 261 \eTD \bTD 158 \eTD \bTD ~767 \eTD \eTR + \bTR \bTD GPV \eTD \bTD 117 \eTD \bTD 192 \eTD \bTD 291 \eTD \bTD ~600 \eTD \eTR + \eTABLEbody +\eTABLE +\stopbuffer + +\start +\switchtobodyfont[8pt] +\typebuffer +\stop + +The meaning of the \CONTEXT\ commands are indicated in \in {table} +[tab:tablecommands02]. + +\placetable + [] + [tab:tablecommands02] + {Commands to define natural tables.} + {\starttable[|l|l|] + \HL + \NC \bf Command \NC \bf Meaning \NC\SR + \HL + \NC \type{\bTABLE ... \eTABLE} \NC begin end table \NC\FR + \NC \type{\bTR ... \eTR} \NC begin end row \NC\MR + \NC \type{\bTD ... \eTD} \NC begin end column \NC\MR + \NC \type{\bTABLEhead ... \eTABLEhead} \NC begin end tablehead \NC\MR + \NC \type{\bTABLEbody ... \eTABLEbody} \NC begin end tablebody \NC\MR + \NC \type{\bTABLEfoot ...\eTABLEfoot} \NC begin end tablefoot \NC\MR + \NC \type{\setupTABLE} \NC table setup \NC\LR + \HL + \stoptable} + +You can find more information on this table mechanism on the \CONTEXTWIKI\ and +examples in the \goto {\em Natural Tables} [ url (manual:nattab) ] manual. + +\stopsection + +\startsection[title=Extreme tables] + +For large tables that extend over a number of pages and where you want the +table head repeated after each pagebreak \CONTEXT\ has the {\em extreme table} +mechanism. + +\shortsetup{startxtable} + +\startbuffer +\setupxtable[split=yes,header=repeat] +\setupxtable[offset=4pt] + +\placetable + [] + [tab:wealthdecline] + {Decline of wealth through the ages.} + {\startxtable + \startxtablehead[align=middle,foregroundstyle=bold] + \startxrow + \startxcell[nx=6] + Decline of wealth in Dutch florine (Dfl) + \stopxcell + \stopxrow + \startxrow[foregroundstyle=bold] + \startxcell[width=1.2cm] Year \stopxcell + \startxcell 1.000--2.000 \stopxcell + \startxcell 2.000--3.000 \stopxcell + \startxcell 3.000--5.000 \stopxcell + \startxcell 5.000--10.000 \stopxcell + \startxcell over 10.000 \stopxcell + \stopxrow + \stopxtablehead + \startxtablenext + \startxrow + \startxcell[nx=6,align=middle,foregroundstyle=bold] + Decline of wealth in Dutch florine (Dfl) / Continued + \stopxcell + \stopxrow + \startxrow[foregroundstyle=bold] + \startxcell Year \stopxcell + \startxcell 1.000--2.000 \stopxcell + \startxcell 2.000--3.000 \stopxcell + \startxcell 3.000--5.000 \stopxcell + \startxcell 5.000--10.000 \stopxcell + \startxcell over 10.000 \stopxcell + \stopxrow + \stopxtablenext + \startxtablebody[align=middle] + \startxrow + \startxcell 1675 \stopxcell + \startxcell 22 \stopxcell + \startxcell ~7 \stopxcell + \startxcell ~5 \stopxcell + \startxcell ~4 \stopxcell + \startxcell ~5 \stopxcell + \stopxrow + \startxrow + \startxcell 1724 \stopxcell + \startxcell ~4 \stopxcell + \startxcell ~4 \stopxcell + \startxcell -- \stopxcell + \startxcell ~4 \stopxcell + \startxcell ~3 \stopxcell + \stopxrow + \startxrow + \startxcell 1750 \stopxcell + \startxcell 12 \stopxcell + \startxcell ~3 \stopxcell + \startxcell ~2 \stopxcell + \startxcell ~2 \stopxcell + \startxcell -- \stopxcell + \stopxrow + \startxrow + \startxcell 1808 \stopxcell + \startxcell ~9 \stopxcell + \startxcell ~2 \stopxcell + \startxcell -- \stopxcell + \startxcell -- \stopxcell + \startxcell -- \stopxcell + \stopxrow + \stopxtablebody + \stopxtable} +\stopbuffer + +\start +\switchtobodyfont[8pt] +\typebuffer +\stop + +With the \type{\setupxtable} it is indicated that the table is allowed to split +at a pagebreak and that the head should contain the content of the \type {\start +... \stopxtablenext}. + +The result of this definition is shown in \in {table} [tab:wealthdecline]. + +\getbuffer + +The meaning of the commands are explained \in {table} [tab:tablecommands03]. + +\placetable + [] + [tab:tablecommands03] + {Commands to define extreme tables.} + {\starttable[|l|l|] + \HL + \NC \bf Command \NC \bf Meaning \NC\SR + \HL + \NC \type{\startxtable ... \stopxtable} \NC begin end table \NC\FR + \NC \type{\startxrow ... \stopxrow} \NC begin end row \NC\MR + \NC \type{\startxcell ... \stopxcell} \NC begin end column \NC\MR + \NC \type{\startxtablehead ... \stopxtablehead} \NC begin end tablehead \NC\MR + \NC \type{\startxtablebody ... \stopxtablebody} \NC begin end tablebody \NC\MR + \NC \type{\startxtablefoot ... \stopxtablefoot} \NC begin end tablefoot \NC\MR + \NC \type{\setupxtable} \NC table setup \NC\LR + \HL + \stoptable} + +More information and examples can be found in the \goto {\em Extreme Tables} [ +url (manual:extab) ] manual. + +\stopsection + +\startsection[title=Placing tables] + +In all examples you see the command \type{\placetable}. This command has +the same function as \type{placefigure}. It takes care of the vertical +spacing and numbering. The float mechanism is invoked and the table will +end up on the most optimal location in your document. + +\shortsetup{placefloat} + +You can also set up the layout of tables with: + +\shortsetup{setupfloats} + +You can set up the numbering and the labels with: + +\shortsetup{setupcaptions} + +These commands are typed in the set up area of your input file and have a global +effect on all floating blocks. + +\startbuffer +\setupfloats[location=left] +\setupcaptions[style=boldslanted,location={right,middle}] + +\placetable[here][tab:opening hours]{Library opening hours.} + {\bTABLE[offset=4pt] + \bTR \bTD \bf Day \eTD \bTD[nx=2,align=middle] \bf Opening hours \eTD \eTR + \bTR \bTD Monday \eTD \bTD 14.00 -- 17.30 \eTD \bTD 18.30 -- 20.30 \eTD \eTR + \bTR \bTD Tuesday \eTD \bTD \eTD \bTD \eTD \eTR + \bTR \bTD Wednesday \eTD \bTD 10.00 -- 12.00 \eTD \bTD 14.00 -- 17.30 \eTD \eTR + \bTR \bTD Thursday \eTD \bTD 14.00 -- 17.30 \eTD \bTD 18.30 -- 20.30 \eTD \eTR + \bTR \bTD Friday \eTD \bTD 14.00 -- 17.30 \eTD \bTD \eTD \eTR + \bTR \bTD Saturday \eTD \bTD 10.00 -- 12.30 \eTD \bTD \eTD \eTR + \eTABLE} +\stopbuffer + +\start +\switchtobodyfont[8pt] +\typebuffer +\stop + +The result is displayed in \in{table}[tab:opening hours]. + +\start +\getbuffer +\stop + +\stopsection + +% AFO: the \start ... \stoplinetable mechanism is not stable enough + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-tablesofcontent.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-tablesofcontent.tex new file mode 100644 index 000000000..0bc81014e --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-tablesofcontent.tex @@ -0,0 +1,174 @@ +\startcomponent ma-cb-en-tablesofcontent + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Table of contents (lists)] + +\index{table of contents} +\index{list} + +\Command{\tex{completecontent}} +\Command{\tex{placecontent}} +\Command{\tex{definelist}} +\Command{\tex{setuplist}} +\Command{\tex{writetolist}} +\Command{\tex{writebetweenlist}} +\Command{\tex{definecombinedlist}} +\Command{\tex{setupcombinedlist}} + +A table of contents contains chapter numbers, chapter titles and page numbers and +can be extended with sections, sub sections, etc. A table of contents is +generated automatically by typing: + +\starttyping +\placecontent +\stoptyping + +Which table of contents is produced depends on the location of this command in +your document. At the start of the document it will generate a list of chapters, +sections etc. But at the top of a chapter: + +\startbuffer +\chapter{Hasselt in Summer} + +\placecontent + +\section{Hasselt in July} + +\section{Hasselt in August} + +\stopbuffer + +\typebuffer + +it will only produce a list of (sub) section titles with the corresponding +section numbers and page numbers. + +The predefined command \type{\placecontent} is available because it was defined +with: + +\shortsetup{definecombinedlist} + +This command and \type{\definelist} allows you to define your own lists necessary +for accessing your documents. + +The use of this command and its related commands is illustrated for the default available +table of contents. + +\startbuffer +\definelist[chapter] +\setuplist + [chapter] + [before=\blank, + after=\blank, + style=bold] + +\definelist[section] +\setuplist + [section] + [alternative=d] +\stopbuffer + +\typebuffer + +Now there are two lists of chapters and sections and these will be combined in a +table of contents with the command \type{\definecombinedlist}. + +\startbuffer +\definecombinedlist + [content] + [chapter,section] + [level=subsection] +\stopbuffer + +\typebuffer + +Now two commands are available: \type{\placecontent} and \type{\completecontent}. +With the second command the title of the table of contents will be added to the +table of contents. + +The layout of lists can be varied with the parameter \type{alternative}. + +\placetable + [here,force] + [tab:alternatives] + {Alternatives for displaying lists.} + {\starttable[|c|l|] + \HL + \NC \bf Alternative \NC \bf Display \NC\SR + \HL + \NC \type{a} \NC number -- title -- page number \NC\FR + \NC \type{b} \NC number -- title -- spaces -- page number \NC\MR + \NC \type{c} \NC number -- title -- dots -- page number \NC\MR + \NC \type{d} \NC number -- title -- page number (continuing) \NC\MR + \NC \type{e} \NC reserved for interactive purposes \NC\MR + \NC \type{f} \NC reserved for interactive purposes \NC\MR + \NC \type{g} \NC reserved for interactive purposes \NC\LR + \HL + \stoptable} + +Lists are set up with: + +\shortsetup{setuplist} +\shortsetup{setupcombinedlist} + +If you want to change the layout of the generated table of contents you'll have +to remember that it is a (combined) list and that we can set the partial lists +separately. + +\startbuffer +\setuplist + [section] + [textstyle=bold, + pagestyle=bold, + numberstyle=bold] +\stopbuffer + +\typebuffer + +This will result in a bold page number, section title and section number. + +Lists are generated and placed with: + +\shortsetup{placelist} + +So if you want a list of sections at the beginning of a new chapter, you type: + +\starttyping +\placelist[section] +\stoptyping + +only the sections will be displayed. + +A long list or a long table of contents will use up more than one page. To be +able to force page breaking you can type: + +\starttyping +\placecontent[extras={8.2=page}] +\stoptyping + +A page break will then occur after section 8.2. + +In some cases you want to be able to write your own text in an automatically +generated list. This is done with: + +\shortsetup{writetolist} +\shortsetup{writebetweenlist} + +For example if you want to make a remark in your table of contents after a +section titled {\em Hotels in Hasselt} you can type: + +\startbuffer +\section{Hotels in Hasselt} +\writebetweenlist[section]{\blank} +\writetolist[section][location=here]{}{Section under construction} +\writebetweenlist[section]{\blank} +\stopbuffer + +\typebuffer + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-tabulations.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-tabulations.tex new file mode 100644 index 000000000..5ed877c76 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-tabulations.tex @@ -0,0 +1,163 @@ +\startcomponent ma-cb-en-tabulations + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=tabulation,title=Tabulation / Paragraph formatting] + +\index{tabulation} +\index{tables+running text} +\index{columns} +\Command{\tex{starttabulate}} +\Command{\tex{definetabulate}} +\Command{\tex{setuptabulate}} +\Command{\tex{NR}} +\Command{\tex{NC}} + +Sometimes you want to typeset paragraphs in a specific formatted way. This is +done with: + +\shortsetup{starttabulate} + +The tabulation mechanism is closely related to the table mechanism. You can use +the tabulation mechanism in cases you want to typeset complete paragraphs within +a cell. The tabulation mechanism also works fine at a page break. + +\startbuffer +\starttabulate[|w(1.5cm)B|p(6.0cm)|p|] +\NC 1252 + \NC Hasselt obtains its city charter from bishop Hendrik + van Vianden. + \NC Hendrik van Vianden was pressed by other towns not + to agree with the charter. It took Hasselt a long + period of time to convince the Bishop. After + supporting the Bishop in a small war against the + Drents, the charter was released. \NC\NR +\NC 1350 + \NC Hasselt joins the Hanzepact to protect their + international trade. + \NC The Hanzepact was of great importance for merchants + in Hasselt. In those days trading goods were taxed + at every city, highway or rivercrossing. After + joining the Hanzepact duty free routes all over + Europe became available to Hasselt. However + important the Hanzepact was, Hasselt always stayed a + minor member of the pact. \NC\NR +\stoptabulate +\stopbuffer + +A tabulate definition could look like this: + +\typebuffer + +In this case the first column is \unit{1.5 centi meter} wide and is typeset bold +(\type{B}). The second column has a width of \unit{6 centi meter} and is typeset +like a paragraph. The remaining horizontal space is used up by the last +paragraph. + +The example is typeset like this: + +\getbuffer + +The tabulation entries are placed between the \type{\start ... \stoptabulate} +pair. Between the bracket pair your can specify the tabulate format with the +column separators \type{|} and the format keys (see \in {table} +[tab:tabularformattingkeys]). + +\placetable[][tab:tabularformattingkeys] + {Formatting keys for tabulate.} + {\starttable[|lT|l|lT|l|] + \HL + \NC \rm \bf Key \NC \rm \bf Meaning + \NC \rm \bf Key \NC \rm \bf Meaning + \NC \SR + \HL + \NC l \NC left align + \NC I \NC \it italic + \NC \FR + \NC c \NC center + \NC R \NC \sl roman + \NC \MR + \NC r \NC right align + \NC S \NC \sl slanted + \NC \MR + \NC i\sl n \NC spacing left + \NC T \NC \tt teletype + \NC \MR + \NC j\sl n \NC spacing right + \NC m \NC in||line math + \NC \MR + \NC k\sl n \NC spacing around + \NC M \NC display math + \NC \MR + \NC w({\sl d}) \NC 1 line, fixed width + \NC f\tex{command} \NC font specification + \NC \MR + \NC p({\sl d}) \NC paragraph, fixed width + \NC b\arg{..} \NC place \type{..} before the entry + \NC \MR + \NC p \NC paragraph, maximum width + \NC a\arg{..} \NC place \type{..} after the entry + \NC \MR + \NC B \NC \bf boldface + \NC h\tex{command} \NC apply \tex{command} on the entry + \NC \LR + \HL + \stoptable} + +In \in {table} [tab:tabulatestructurecommands] you find an overview +of the tabulate structuring commands. + +\placetable + [] + [tab:tabulatestructurecommands] + {Commands to define tabulate.} + {\starttable[|l|l|l|] + \HL + \NC \bf Command \NC \NC \bf Meaning \NC\SR + \HL + \NC \type{\start ... \stoptabulate} \NC \NC begin end tabulate \NC\FR + \NC \type{\NC} \NC next column \NC next column \NC\MR + \NC \type{\NR} \NC next row \NC next row \NC\MR + \NC \type{\HL} \NC horizontal line \NC horizontal line \NC\MR + \NC \type{\TB} \NC table blank \NC empty line \NC\MR + \NC \type{\definetabulate} \NC \NC define own tabulate \NC\MR + \NC \type{\setuptabulate} \NC \NC tabulate setup \NC\LR + \HL + \stoptable} + +Another example of paragraph formatting could look like this. + +\startbuffer +\definetabulate[ChemPar][|l|p|l|] + +\startChemPar +\NC Limekilns + \NC Hasselt has its own limekilns. These were build in 1504 + and produced quick lime up to 1956. Nowadays they are a + tourist attraction. + \NC \inlinechemical{CaCO_3,GIVES,CaO,+,CO_2} \NC\NR +\stopChemPar +\stopbuffer + +\typebuffer + +And it would come out like this: + +\getbuffer + +In \in{chapter}[chemical] your can find some more information on chemistry +and \CONTEXT. + +Here we also introduced the command to define our own paragraph layout. + +\shortsetup{definetabulate} + +and we also have: + +\shortsetup{setuptabulate} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-textbackgrounds.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-textbackgrounds.tex new file mode 100644 index 000000000..0f4689f3f --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-textbackgrounds.tex @@ -0,0 +1,55 @@ +\startcomponent ma-cb-en-textbackgrounds + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Background in paragraphs] + +\index{background+text} + +\Command{\tex{setuptextbackground}} +\Command{\tex{definetextbackground}} +\Command{\tex{starttextbackground}} + +To emphasize a paragraph you can use backgrounds. A background is set with the +command pair: + +\shortsetup{starttextbackground} + +An example can illustrate the use: + +\startbuffer +\setuptextbackground + [corner=round,frame=on, + location=paragraph, + leftoffset=.5\bodyfontsize, + rightoffset=.5\bodyfontsize, + bottomoffset=5pt] + +\starttextbackground +Hasselt has produced a number of well known people. Only recently +it turned out that Kilian van Rensselaer played a prominent role +in the foundation of the State of New York. +\stoptextbackground +\stopbuffer + +\typebuffer + +This would be displayed as: + +\getbuffer + +Backgrounds can span multiple pages. + +You can vary the display of the backgrounds with: + +\shortsetup{setuptextbackground} + +You can even define your own text backgrounds with: + +\shortsetup{definetextbackground} + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-texteditor.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-texteditor.tex new file mode 100644 index 000000000..bed8017d5 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-texteditor.tex @@ -0,0 +1,32 @@ +\startcomponent ma-cb-en-texteditor + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=texteditor,title=The \SCITE\ text editor] + +The developers of \CONTEXT\ have always been able to proces their \TEX\ files +from a text editor. In that way \CONTEXT\ became an effective authoring tool. + +At this moment the text editors \SCITE\ and \TEXWORKS\ are more or less part of +the \CONTEXT\ distribution. + +Please refer to the \goto {\CONTEXTWIKI} [ url (http://wiki.contextgarden.net/Windows_Installation:_ConTeXt_Suite_with_SciTe) ] +and learn how to install \SCITE. + +\SCITE\ supports the: + +\startitemize[packed] +\item processing \TEX\ of files +\item colored display of commands (lexing) +\item syntax checking of \TEX, \XML\ and \LUA\ files +\item spell checking of your text +\stopitemize + +The \CONTEXT\ specific support of \SCITE\ is described in the manual \goto +{\SCITE\ in \CONTEXT} [ url (manual:scite) ]. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-units.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-units.tex new file mode 100644 index 000000000..ce596c0b5 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-units.tex @@ -0,0 +1,101 @@ +\startcomponent ma-cb-en-units + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[reference=units,title=Units] + +\index{units} +\index[siunit]{SI--unit} + +\Command{\tex{unit}} + +To force yourself to use dimensions and units consistently throughout your +document you can use the \type{\unit} command. Let's give a few examples: + +\startbuffer +\unit{meter per square meter} +\unit{cubic meter per sec} +\unit{square milli meter per inch} +\unit{centi liter per sec} +\unit{meter inverse sec} +\unit{newton per square inch} +\unit{newton times meter per square sec} +\stopbuffer + +\typebuffer + +It looks like a lot of typing but it does guarantee a consistent use of units. +The command \type{\unit} also prevents linebreaking between number and unit. +The examples above come out as: + +\startnarrower +\startlines +\getbuffer +\stoplines +\stopnarrower + +You can add your own units with: + +\shortsetup{registerunit} + +and set them up with: + +\shortsetup{setupunit} + +\startbuffer +\registerunit[unit][inhab=inhabitants] \setupunittext[inhabitants=inh] +\registerunit[unit][north=north] \setupunittext[north= N] +\registerunit[unit][east=east] \setupunittext[east= E] + +Hasselt is part of the municipality of Zwartewaterland +(coordinates \unit {52 degrees 35 arcminute north}, +\unit {6 degrees 5 arcminute east}). Its area is about +\unit {88 square kilometer} (land \unit {83 square kilom} +and water \unit{5 square km}). As of 1st Augustus 2013 the +population is 22.201 that is \unit {268 inhab per square kilo +meter}). +\stopbuffer + +In the example below you can see some new units and the non-consistent +use of \unit{kilo meter}. + +\typebuffer + +This results in: + +\getbuffer + +The \type{\unit} command also allows you to align rows of units in a column. + +\startbuffer +\bTABLE +\bTR \bTD \bf Street \eTD \bTD \bf Length \eTD \eTR +\bTR \bTD Ridderstraat \eTD \bTD \unit{_,160 meter} \eTD \eTR +\bTR \bTD Prinsengracht \eTD \bTD \unit{_,240 meter} \eTD \eTR +\bTR \bTD Kalverstraat \eTD \bTD \unit{_,_60 meter} \eTD \eTR +\bTR \bTD H.A.W. van de Vechtlaan \eTD \bTD \unit{1,250 meter} \eTD \eTR +\bTR \bTD Meestersteeg \eTD \bTD \unit{_,_45 meter} \eTD \eTR +\eTABLE +\stopbuffer + +When you type: + +\typebuffer + +It will generate a well aligned second column: + +\bgroup +\setupTABLE[frame=off,offset=0pt] +\setupTABLE[c][1][width=4.5cm] + +\getbuffer +\egroup + +Please refer to the manual \goto {\em Units} [ url(manual:units) ] for more +information and details. + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-usersetups.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-usersetups.tex new file mode 100644 index 000000000..2d89e937a --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-usersetups.tex @@ -0,0 +1,68 @@ +\startcomponent ma-cb-en-usersetups + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=User specifications] + +\index{preamble} +\index{input file} + +The setup area of your document is the area before +the \type{\starttext} command. For example: + +\setuptyping + [escape=yes] + +\definestartstop + [comment][style={\rm}] + +\starttyping + /BTEX \comment{first line of your file} /ETEX +\setuplayout[width=25cm] /BTEX \comment{set the width of your text} /ETEX + /BTEX \comment{empty line for readability} /ETEX +\starttext /BTEX \comment{starts your text} /ETEX +Hello Hasselt. /BTEX \comment{your text} /ETEX +\stoptext /BTEX \comment{ends your text} /ETEX +\stoptyping + +Note that the first line of this file is empty. However, this first line +is a preamble and can be used for specific user specifications. For example: + +\starttyping +% engine=luatex /BTEX \comment{use the \type{luatex} engine} /ETEX + /BTEX \comment{empty line for readability} /ETEX +\setuplayout[width=25cm] /BTEX \comment{set the width of your text} /ETEX + /BTEX \comment{empty line for readability} /ETEX +\starttext /BTEX \comment{starts your text} /ETEX +Hello Hasselt. /BTEX \comment{your text} /ETEX +\stoptext /BTEX \comment{ends your text} /ETEX +\stoptyping + +Note that \CONTEXT\ sees the text after the \type{ % } +sign in this first line not as a comment. + +The preamble can have a meaning for both \CONTEXT\ and \SCITE: + +\starttyping +% engine=pdftex interface=en modes=screen language=uk + +\starttext +Hello Hasselt. +\stoptext +\stoptyping + +This will be interpreted as: + +\starttabulate[|T||p|] +\NC engine=pdftex \NC \CONTEXT \EQ run as \PDFTEX \NC\NR +\NC interface=en \NC \CONTEXT \EQ expect english \CONTEXT\ commands (lexing) \NC\NR +\NC \NC \SCITE \EQ use english lexing \NC\NR +\NC modes=screen \NC \CONTEXT \EQ invoke mode \type{screen} that is set in the text \NC\NR +\NC language=uk \NC \SCITE \EQ use the english spell checker \NC\NR +\stoptabulate + +\stopchapter + +\stopcomponent diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en-whatever.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en-whatever.tex new file mode 100644 index 000000000..aa61bb0cb --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en-whatever.tex @@ -0,0 +1,1079 @@ +\startcomponent ma-cb-en-whatever + +\enablemode[**en-us] + +\project ma-cb + +\startchapter[title=Miscellaneous] + +\startsection[title=A titlepage] + +\index{titlepage} + +\Command{\tex{startstandardmakeup}} +\Command{\tex{definemakeup}} +\Command{\tex{setupmakeup}} + +In the first example of this manual on \at{page}[inputfile] we used the command: + +\shortsetup{startnamemakeup} +%\shortsetup{start<<name>>makeup} % does not work + +This command can be used to define titlepages. Such a command is needed since +title pages often have a different layout than that of the bodytext. With the +command pair \type{\start ... \stopstandardmakeup} you can make up a page within +the default page dimensions. + +A simple titlepage may look like this: + +\startbuffer +\startstandardmakeup +\blank +\rightaligned{\tfd Hasselt in the 21st century} +\blank +\rightaligned{\tfb The future} +\vfill +\rightaligned{\tfa C. van Marle} +\rightaligned{Hasselt, 2013} +\stopstandardmakeup +\stopbuffer + +\typebuffer + +In a doublesided document you have to go through some additional actions to +typeset the back of the titlepage. + +\startbuffer +\startstandardmakeup[doublesided=no] +\blank +\rightaligned{\tfd Hasselt in the 21st century} +\blank +\rightaligned{\tfb The future} +\vfill +\rightaligned{\tfa C. van Marle} +\rightaligned{Hasselt, \currentdate[year]} +\stopstandardmakeup +\startstandardmakeup[page=no] +\vfill +\copyright \currentdate[year] + +This book is dedicated to the people living in Hasselt. We +want to thank photographer J. Jonker for manipulating the +photos in this book in such a way that readers can get a +clear picture of Hasselt's future look. +\stopstandardmakeup +\stopbuffer + +\typebuffer + +Your own make ups can be made and set up with: + +\shortsetup{definemakeup} + +and + +\shortsetup{setupmakeup} + +Please refer to the \goto {\CONTEXTWIKI} [ url (http://wiki.contextgarden.net/Command/setupmakeup) ] +for more information on the \type{\start...\stopmakeup} command. + +\stopsection + +\startsection[reference=overlays,title=Overlays] + +\index{overlay} + +The overlay mechanism gives you the opportunity to add a specific layout +to a text component. When there is a background option in a \CONTEXT\ command +you can use overlays. + +\startbuffer +\defineoverlay + [verticalbar] + [{\blackrule[height=2cm,width=.5cm,color=red]}] + +\defineoverlay + [horizontalbar] + [{\blackrule[height=.5cm,width=12cm,color=red]}] + +\framed + [width=12cm, + height=6cm, + background={color,foreground,verticalbar,horizontalbar}, + offset=overlay, + backgroundcolor=blue, + frame=off] + {\blackrule[width=12cm,height=2cm,color=white]} +\stopbuffer + +The flag of Hasselt could be defined with framed and a number of overlays: + +\typebuffer + +This will become: + +\startlinecorrection +\getbuffer +\stoplinecorrection + +The pagenumber in this manual has a background with an overlay where the +\type{\MPclipFive} command takes care of drawing the image with \METAPOST. + +\startbuffer +\defineoverlay + [NumberBackground] + [\MPclipFive{\overlaywidth}{\overlayheight}{30pt}{5pt}] + +\setuppagenumbering + [\location={footer,middle}, + \command=\NummerCommand] + +\def\NummerCommand#1% + {\framed + [\background=NumberBackground, + \frame=off, + \offset=6pt] + {\lower.5\dp\strutbox\hbox spread 60pt{\hss#1\hss}}} +\stopbuffer + +\typebuffer + +\stopsection + +\startsection[reference=setups,title=Setups] + +\index{setups} + +\Command{\tex{setup}} + +While defining the layout of a document you can define setups +with \type{\start...\stopsetups}. Setups are placed in the setup area of +input file and mostly used to combine a number of commands. + +\startbuffer +\startsetups colorize + \blue +\stopsetups + +\startsetups decolorize + \black +\stopsetups + +\setupitemize + [before=\setups{colorize}, + after=\setups{decolorize}] + +Some data on the church are: + +\startitemize[packed,3*broad] +\sym{997} mentioned for the first time +\sym{1380} destroyed by fire +\sym{1466} rebuild +\sym{1657} restored after shelling by enemy troops +\sym{1725} struck by lightning +\stopitemize + +\stopbuffer + +\typebuffer + +Which would result in: + +\start % AFO: to keep color and distance local +\getbuffer +\stop + +Another way of invoking the setups is by the \type{setups} option +that comes with some \CONTEXT\ commands: + +\startbuffer +\definestartstop[remark] + +\setupstartstop[remark] + [before=\startframed, + after=\stopframed] + +\startsetups important + \inleftmargin + [scope=local, + hoffset=1em]{\bf\color[blue]{→}} +\stopsetups + +\setupframed + [align=normal, + setups=important, + frame=on, + framecolor=blue, + offset=5pt] + +\startremark + The Stephanus Church was built in 997. After an enormous + fire in 1380 it was rebuilt and that's why it has Gothic + features. The rebuilding was finished in 1466.\endgraf +\stopremark +\stopbuffer + +\typebuffer + +This becomes: + +\blank + +\start +\getbuffer +\stop + +\stopsection + +\startsection[reference=variables,title=Variables] + +\index{variables} + +\Command{\tex{getvariable}} +\Command{\tex{setvariables}} + +There is a mechanism in \CONTEXT\ that enables you to compact information in a +list of variables that you can recall throughout the document. + +\shortsetup{setvariables} + +The example below shows how to use variables in defining a coverpage. + +\startbuffer +\setvariables + [cover] + [set=\setups{coverpage}, + student=no, + teacher=yes, + title=From Hasselt to America, + subtitle=An Odyssey, + authors=\setup{allauthors}, + edition=2012, + isbn=0123456789] +\stopbuffer + +\typebuffer + +The moment you need the title on your cover page (or somewhere else in your document) you can +summon it by: + +\startbuffer +\getvariable{cover}{title} +\stopbuffer + +\typebuffer + +\stopsection + +\startsection[reference=floatingblocks,title=Floating blocks] + +\index{floating blocks} +\index{postponing a block} + +\Command{\tex{definefloat}} +\Command{\tex{setupfloat}} +\Command{\tex{setupfloats}} +\Command{\tex{setupcaptions}} +\Command{\tex{placeintermezzo}} + +A block in \CONTEXT\ is a text element, for example a table or a figure that you +can process in a special way. You have already seen the use of +\type{\placefigure} and \type{\placetable}. These are both examples of floating +blocks. The floating mechanism is described in \in{chapter}[figures] and +\in[tables]. + +You can define these kind of blocks yourself with: + +\shortsetup{definefloat} + +The bracket pairs are used for the name in singular and +plural form. For example: + +\starttyping +\definefloat[intermezzo][intermezzi] +\stoptyping + +Now the following commands are available: + +\starttyping +\placeintermezzo[][]{}{} +\startintermezzotext ... \stopintermezzotext +\placelistofintermezzi +\completelistofintermezzi +\stoptyping + +The newly defined floating block can be set up with: + +\shortsetup{setupfloat} + +You can set up the layout of floating blocks with: + +\shortsetup{setupfloats} + +You can set up the numbering and the labels with: + +\shortsetup{setupcaption} + +These commands are typed in the set up area of your input file and will have a +global effect on all floating blocks. + +\setupframedtexts + [width=.8\makeupwidth, + background=color, + backgroundcolor=gray, + corner=round, + framecolor=blue, + rulethickness=2pt] + +\startbuffer +\setupfloat[intermezzo][location=middle] +\setupcaption[location=bottom,headstyle=boldslanted] + +\placeintermezzo{An intermezzo.} +\startframedtext +At the beginning of this century there was a tram line from +Zwolle to Blokzijl via Hasselt. Other means of transport became +more important and just before the second world war the tram line +was stopped. Nowadays such a tram line would have been very +profitable. +\stopframedtext +\stopbuffer + +\typebuffer + +\start +\getbuffer +\stop + +The framed texts inherits its layout from the example \at{page}[block:bridge]. + +Tables or figures may take up a lot of space. The placing of these text elements +can be postponed till the next page break. This is done with: +\type{\start ... \stoppostponing}: + +\startbuffer +\startpostponing +\placefigure + {A postponed figure.} + {\externalfigure[ma-cb-16][width=\textwidth]} +\stoppostponing +\stopbuffer + +\typebuffer + +The figure will be placed at the top of the next page and will cause minimal +disruption of the running text. + +\getbuffer + +\stopsection + +% \startsection[reference=textblocks,title=Text blocks] % AFO 2013: weggehaald, wordt toch nooit gebruikt + +% \index{text blocks} + +% \Command{\tex{defineblock}} +% \Command{\tex{useblocks}} +% \Command{\tex{hideblocks}} +% \Command{\tex{setupblock}} + +% \stopsection + +\startsection[title=Storing text for later use] + +\index{storing text} + +\Command{\tex{startbuffer}} +\Command{\tex{getbuffer}} +\Command{\tex{typebuffer}} +\Command{\tex{savebuffer}} +\Command{\tex{setupbuffer}} + +You can store information temporarily for future use in your document with: + +\shortsetup{startbuffer} + +For example: + +\starttyping +\startbuffer[visit] +If you want to see what Hasselt has in store you should come and +visit it some time. If you take this manual with you, you will +recognise some locations. +\stopbuffer + +\getbuffer[visit] +\stoptyping + +With \type{\getbuffer[visit]} you recall the stored text. The logical name is +optional. With \type{\typebuffer[visit]} you get back the typeset version of the +content of the buffer. + +Buffers are set up with: + +\shortsetup{setupbuffer} + +You can also save a buffer to an external file with: + +\shortsetup{savebuffer} + +If you want to save the buffer \type{visit} in an external file called +\type{myfile-sightseeing.tmp} you type: + +\starttyping +\savebuffer[visit][sightseeing] +\stoptyping + +\stopsection + +\startsection[title=Lines] + +\index{lines} + +\Command{\tex{hairline}} +\Command{\tex{starttextrule}} +\Command{\tex{thinrule}} +\Command{\tex{thinrules}} +\Command{\tex{setupthinrules}} +\Command{\tex{underbar}} +\Command{\tex{overstrikes}} +\Command{\tex{periods}} + +There are many comands to draw lines. For a single line you type: + +\shortsetup{hairline} + +or: + +\shortsetup{thinrule} + +For more lines you type: + +\shortsetup{thinrules} + +Text in combination with lines is also possible: + +\startbuffer +\starttextrule{Hasselt -- Amsterdam} +If you draw a straight line from Hasselt to Amsterdam you would have +to cover a distance of almost 145 \unit{Kilo Meter}. +\stoptextrule + +If you draw two straight lines from Hasselt to Amsterdam you would +have to cover a distance of almost 290 \unit{Kilo Meter}. + +Amsterdam \thinrules[n=3] Hasselt +\stopbuffer + +\getbuffer + +The code of this example is: + +\typebuffer + +You always have to be careful in drawing lines. Empty lines around +\type{\thinrules} must not be forgotten and the vertical spacing is always a +point of concern. + +You can set up line spacing with: + +\shortsetup{setupthinrules} + +There are a few complementary commands that might be very +useful. + +\shortsetup{setupfillinrules} + +These commands are introduced in the examples below: + +\startbuffer +\setupfillinrules[width=2cm] +\setupfillinlines[width=3cm] + +\fillinrules[n=1]{\bf name} +\fillinrules[n=3]{\bf adress} + +\fillinline{Can you please state the \underbar{number} of houses + in Hasselt.} \par + +Strike out \overstrikes{Hasselt in this text}\periods[18] +\stopbuffer + +\typebuffer + +This will become: + +\getbuffer + +These commands are used in questionaires. Text that is +struck out or underlined will not be hyphenated. + +In \in{section}[overlays] you have already seen the use of the +\type{\blackrule} command that can be set up with: + +\shortsetup{setupblackrules} + +\startbuffer +\blank +\blackrule[width=\textwidth,height=1cm,color=blue] +\stopbuffer + +\typebuffer + +This will result in a rather fat line: + +\getbuffer + + +\stopsection + +\startsection[title=Super- and subscript in text] + +\index{subscript} +\index{superscript} + +\Command{\tex{low}} +\Command{\tex{high}} +\Command{\tex{lohi}} + +\startbuffer +Hasselt's economy has known its \high{ups} and \low{downs}. +Since the nineties of the last century its economy is +\lohi{so}{so}. +\stopbuffer + +\getbuffer + +This ugly text was made with \type{\low{}}, \type{\high{}} and \type{\lohi{}{}}. +The text was placed between the curly braces. + +\stopsection + +\startsection[title=Date] + +\index{date} + +\Command{\tex{currentdate}} + +You can invoke the system date in your text with: + +\shortsetup{currentdate} + +With \type{\currentdate[day]}, \type{\currentdate[month]} and \type{\currentdate[year]} you can +invoke day, month and year separately. + +\stopsection + +\startsection[title=Rotating text, figures and tables] + +\index{rotating} + +\Command{\tex{rotate}} + +Sometimes you may want to rotate text or images. You can rotate +text and other objects with: + +\shortsetup{rotate} + +The first bracket pair is optional. Within that bracket pair +you specify the rotation: \type{rotation=90}. The curly +braces contain the text or object you want to rotate. + +\startbuffer +Hasselt got its municipal rights in 1252. From that time on it had +the \rotate[rotation=90]{right} to use its own seal on official +documents. This seal showed Holy Stephanus known as one of the first +Christian martyrs, and was the \rotate[rotation=270]{patron} of +Hasselt. After the Reformation the seal was redesigned and Stephanus +lost his \quote{holiness} and was from that time on depicted without +his aureole. +\stopbuffer + +\typebuffer + +This results in a very ugly paragraph: + +\getbuffer + +You can rotate an image just as easily: + +% \placetable[rotate][]{}{} + +\startbuffer +\placefigure + [][fig:rotation] + {The 180 \unit{Degrees} rotated fishing port (de Vispoort).} + {\rotate[rotation=180]{\externalfigure[ma-cb-15][width=10cm]}} +\stopbuffer + +\typebuffer + +You can see in \in{figure}[fig:rotation] that it is not always clear what you get +when you rotate. + +\getbuffer + +We can set up rotating with: + +\shortsetup{setuprotate} + +In the example above you could also rotate image and caption by: + +\startbuffer +\placefigure + [180][fig:rotation] + {The 180 \unit{Degrees} rotated fishing port (de Vispoort).} + {\externalfigure[ma-cb-15][width=10cm]} +\stopbuffer + +\typebuffer + +\stopsection + +\startsection[title=Scaling text] + +\index{scaling} + +\Command{\tex{scale}} +\Command{\tex{setupscale}} + +For some obscure reasons you may want to scale text. You can scale text and other +objects with: + +\shortsetup{scale} + +\startbuffer +After 1810 the Dedemsvaart brought some prosperity to Hasselt. All +ships went through the canals of Hasselt and the \scale[factor=10]{shops} on both +sides of the canals \scale[factor=10]{prospered}. +\stopbuffer + +\typebuffer + +Which will result in: + +\getbuffer + +\stopsection + +\startsection[title=Space] + +\index{space} +\index{tilde} +\index{non-breakable space} + +\Command{\tex{space}} +\Command{\tex{fixedspaces}} + +The command \type{\space} will produce a space. In \CONTEXT\ the +\type{~} (tilde) is a non-breakable space. + +\startbuffer +The Ridderstraat in Hasselt is about 160~m long and 5 to 6~m wide +with houses on both sides of the street. +\stopbuffer + +\typebuffer + +Tildes can also be used to align numbers in a row. The command +\type{\fixedspaces} will give the tilde the fixed width of a number. + +\startbuffer +\fixedspaces + +\bTABLE[frame=off] +\bTR \bTD Ridderstraat \eTD \bTD 160 m \eTD \eTR +\bTR \bTD Prinsengracht \eTD \bTD 240 m \eTD \eTR +\bTR \bTD Kalverstraat \eTD \bTD ~60 m \eTD \eTR +\bTR \bTD Meestersteeg \eTD \bTD ~45 m \eTD \eTR +\eTABLE +\stopbuffer + +\typebuffer + +\stopsection + +\startsection[title=Carriage return] + +\index{carriage return} + +\Command{\tex{crlf}} +\Command{\tex{startlines}} + +A new line can be enforced with: + +\shortsetup{crlf} + +As a \CONTEXT\ user you should use this command only as a last resort. + +When a number of lines should be followed by a {\em carriage return and line feed} +you can use: + +\shortsetup{startlines} + +\starttyping +\startlines +. +. +. +\stoplines +\stoptyping + +\startbuffer +On a wooden panel in the town hall of Hasselt you can read: + +\startlines +Heimelijcken haet +eigen baet +jongen raet +Door diese drie wilt verstaen +is het Roomsche Rijck vergaen. +\stoplines + +This little rhyme contains a warning for the magistrates of +Hasselt: don't allow personal benefits or feelings to +influence your wisdom in decision making. +\stopbuffer + +\typebuffer + +This will become: + +\getbuffer + +In a few commands new lines are generated by \type{\\}. For example if you type +\type{\inmargin{in the\\margin}} then the text will be divided over two lines. + +\stopsection + +\startsection[title=Hyphenation] + +\index{hyphenation} +\index{language} + +\Command{\tex{mainlanguage}} +\Command{\tex{language}} +\Command{\tex{nl}} +\Command{\tex{en}} + +When writing multi-lingual texts you have to be aware of the fact that +hyphenation may differ from one language to another. + +To activate a language you type: + +\shortsetup{mainlanguage} + +Between the brackets you fill in +\type{af}, +\type{ca}, +\type{cs}, +\type{cs}, +\type{da}, +\type{de}, +\type{en}, +\type{fi}, +\type{fr}, +\type{it}, +\type{la}, +\type{nl}, +\type{nb}, +\type{nn}, +\type{pl}, +\type{pt}, +\type{es}, +\type{sv} and +\type{tr} for +afrikaans, +catalan, +czech, +slovak, +danish, +german, +english, +finnish, +french, +italian, +latin, +dutch, +bokmal, +nnynorsk, +polish, +portuguese, +spanish, +swedish and +turkish respectively. + +To change from one language to another you can use: + +\starttyping +\language[nl] \language[en] \language[de] \language[fr] \language[sp] ... +\stoptyping + +or the shorthand versions: + +\starttyping +\nl \en \de \fr \sp ... +\stoptyping + +An example: + +\startbuffer +If you want to know more about Hasselt, the best book to read is +probably \quote{\nl Uit de geschiedenis van Hasselt} by +F.~Peereboom. +\stopbuffer + +\typebuffer + +\getbuffer + +If a word is wrongly hyphenated you can define the hyphenation points yourself. +This is done in the set up area of your input file: + +\startbuffer +\hyphenation{his-to-ry} +\stopbuffer + +\typebuffer + +Note that the language setting is also responsible for the way quotes are placed +around quotes and quotations (see \in{section}[quotations]). + +In some languages (like Dutch) compound words are used that are connected with a +hyphen. The separate words have to be hyphenated correctly. In order to do that +you can use \type{||}. + +\startbuffer +If your looking for an English||speaking person in Hasselt you should +go to the Tourist Information Office. There you may expect to find +full|| and part||time employees who are fluent in German, English, +French and of course Dutch. +\stopbuffer + +\typebuffer + +This will become: + +\getbuffer + +The double \type{||} takes care of the hyphen and the correct hyphenation of the +separate words. Also note the suspended compounds. + +\stopsection + +\startsection[title=Charts] + +\index{chart} + +\Command{\tex{FLOWchart}} + +To enable you to draw flow diagrams \CONTEXT\ contains the core module +\type{chart}. A simple organogram may look like this: + +\startbuffer +\setupFLOWcharts + [width=9\bodyfontsize, + height=2\bodyfontsize, + dx=1\bodyfontsize, + dy=1\bodyfontsize] + +\setupFLOWlines + [arrow=no] + +\startFLOWchart[organogram] + \startFLOWcell + \shape {action} + \name {01} + \location {2,1} + \text {Zwartewaterland} + \connect [bt]{02} + \connect [bt]{03} + \connect [bt]{04} + \stopFLOWcell + \startFLOWcell + \shape {action} + \name {02} + \location {1,2} + \text {Hasselt} + \stopFLOWcell + \startFLOWcell + \shape {action} + \name {03} + \location {2,2} + \text {Zwartsluis} + \stopFLOWcell + \startFLOWcell + \shape {action} + \name {04} + \location {3,2} + \text {Genemuiden} + \stopFLOWcell +\stopFLOWchart +\stopbuffer + +\midaligned{\getbuffer\FLOWchart[organogram]} + +This diagram is defined with the commands below: + +\typebuffer + +It is of good practice to define your setups and flow diagrams in separate +definition files (environments). + +\startbuffer +\FLOWchart[organogram] +\stopbuffer + +The flowchart can then be invoked by: + +\typebuffer + +\stopsection + +\startsection[title=Comment in input file] + +\index{comment} +\index[percent]{\% in input file} + +All text between \type{\start...\stoptext} will be processed while running +\CONTEXT. Sometimes however you may have text fragments you don't want to be +processed or you want to comment on your \CONTEXT\ commands. + +If you preceed your text with the percentage sign \type{%} +it will not be processed. + +\startbuffer +% In very big documents you can use the command \input for +% different files. +% +% For example: +% +% \input hass01.tex % chapter 1 on Hasselt +% \input hass02.tex % chapter 2 on Hasselt +% \input hass03.tex % chapter 3 on Hasselt +\stopbuffer + +\typebuffer + +When you delete the \type{%} before \type{\input} the three files will be +processed. The comment describing the contents of the files will not be +processed. + +\stopsection + +\startsection[title=Notes] + +\index{note} + +\Command{\tex{startcomment}} + +If you want your comment in the input file visible as a 'note' in the PDF file +you can use: + +\shortsetup{startcomment} + +\startbuffer +\startcomment + The image of the Vispoort should be in color. +\stopcomment +\stopbuffer + +\typebuffer + +The command will produce a sticky note in the PDF. + +The note is only visible when interactivity is set with \type{\setupinteraction} +and the comment with \type{\setupcomment}. + +\stopsection + +\startsection[title=Hiding text] + +\index{hiding text} + +\Command{\tex{starthiding}} + +Text can be hidden with: + +\shortsetup{starthiding} + +The text between \type{\start ... \stophiding} will not be processed. + +\stopsection + +\startsection[title=Input of another {\tt tex} file] + +\index{input other \TEX--files} + +\Command{\tex{input}} + +In a number of situations you may want to insert other \TEX\ files in your input +file. For example, sometimes it is more efficient to specify \CONTEXT\ sources in +more than one file in order to be able to partially process your files. + +Another file (with the name \type{another.tex}) can be inserted by: + +\starttyping +\input another.tex +\stoptyping + +The extension is optional so this will work too: + +\starttyping +\input another +\stoptyping + +The command \type{\input} is a \TEX\ command. + +For a more systematic approach in maintaining your documents \CONTEXT\ supports a +project structure with commands like \type{\start...\stopenvironment} and +\type{\start...\stopproduct}. Please refer to the magazine +\goto {\em Project structure} [ url(thisway:proj-struc) ] +for more information. + +\stopsection + +\startsection[title=XML (eXtended Markup Language)] + +\index{xml} +\index{mathml} +\index{openmath} + +Normally you code your document with \CONTEXT\ commands so you can tell \CONTEXT\ +what to do with the coded text elements. + +A more rigid way to code your content is \XML\ (eXtended Markup Language) which enables +you to have more control over your content (scripting, xslt, validation). A simple +\XML\ coded document could look like this: + +\startbuffer +<?xml version='1.0' standalone='yes?> + +<document> + <section> + <title>Hasselt in winter</title> + <content> + <p>In winter scating is a very popular sport in Hasselt. + All over Hasselt the frozen canals offer children a great + play ground.</p> + <p>...</p> + </content> + </section> +</document> +\stopbuffer + +\typebuffer + +\CONTEXT\ is able to deal with \XML\ directly without underlying XML2TEX +conversions. Please refer to the manual \goto {Dealing with XML} [ url +(manual:xml) ] for more information on how to process \XML\ documents. + +\CONTEXT\ also supports \MATHML\ (presentational and content markup) and +\OPENMATH\ with which math expressions can be coded in \XML\ documents. + +\stopsection + +\stopchapter + +\stopcomponent + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en.pdf b/doc/context/sources/general/manuals/start/en/ma-cb-en.pdf Binary files differnew file mode 100644 index 000000000..6ad164eb0 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en.pdf diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-en.tex b/doc/context/sources/general/manuals/start/en/ma-cb-en.tex new file mode 100644 index 000000000..2e0b283af --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-en.tex @@ -0,0 +1,86 @@ +% interface=english language=uk modes=screen,bound + +% \showframe + +\startproduct ma-cb-en + +\project ma-cb + +% \disabledirectives[otf.kernruns] +% \disabledirectives[otf.discruns] +% \disabledirectives[otf.compruns] + +\startdocument + [title={\ConTeXt\ Mark IV\crlf an excursion}, + subtitle={English\crlf version}, + author={Ton Otten\crlf PRAGMA ADE}] + +\startfrontmatter + + \component ma-cb-en-introduction + +\stopfrontmatter + +\startbodymatter + + \component ma-cb-en-document + \component ma-cb-en-gettingstarted + \component ma-cb-en-specialcharacters + \component ma-cb-en-structure + \component ma-cb-en-setupcommands + \component ma-cb-en-heads + \component ma-cb-en-itemizations + \component ma-cb-en-math + \component ma-cb-en-chemical + \component ma-cb-en-units + \component ma-cb-en-bibliography + \component ma-cb-en-figures + \component ma-cb-en-tables + \component ma-cb-en-tabulations + \component ma-cb-en-columns + \component ma-cb-en-footnotes % Hans: zie lokale voetnoot tabel + \component ma-cb-en-citations + \component ma-cb-en-descriptions + \component ma-cb-en-enumerations + \component ma-cb-en-frames % Hans 2015: "background=linear shape" werkt niet en zorgt ervoor dat de background van de shortsetup niet meer werken + \component ma-cb-en-framedtexts + \component ma-cb-en-margintexts + \component ma-cb-en-pages + \component ma-cb-en-headers + \component ma-cb-en-tablesofcontent + \component ma-cb-en-registers + \component ma-cb-en-synonyms + \component ma-cb-en-sortedlists + \component ma-cb-en-references + \component ma-cb-en-color + \component ma-cb-en-alignments + \component ma-cb-en-interactivity % Hans: de soundtrack werkt niet en crossref met hasseltbook.tex werkt niet + \component ma-cb-en-fonts + \component ma-cb-en-composedcharacters + \component ma-cb-en-layout + \component ma-cb-en-pagebackgrounds + \component ma-cb-en-textbackgrounds + \component ma-cb-en-paragraphs + \component ma-cb-en-commands + \component ma-cb-en-whatever + \component ma-cb-en-modules + \component ma-cb-en-presentations + \component ma-cb-en-metapost + \component ma-cb-en-usersetups + +\stopbodymatter + +\startappendices + + \component ma-cb-en-mathcharacters + \component ma-cb-en-errors + \component ma-cb-en-texteditor + \component ma-cb-en-processingfiles + \component ma-cb-en-runtimefiles + +\stopappendices + +\stopdocument + +\stopproduct + diff --git a/doc/context/sources/general/manuals/start/en/ma-cb-language.tex b/doc/context/sources/general/manuals/start/en/ma-cb-language.tex new file mode 100644 index 000000000..5c6d91d07 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/ma-cb-language.tex @@ -0,0 +1,21 @@ +\startenvironment ma-cb-language + +\mainlanguage[en] + +\setuplabeltext + [en] + [ document:author=Main author, + document:design=Design and style, + document:contributions=Contributions, + document:translations=Translations, + document:illustrations=Illustrations, + document:commanddefinitions=Command definitions, + document:commandindex=Command index, + document:subjectindex=Subject index, + document:contents=Contents, + document:manuals=Manuals, + document:magazines=Magazines, + document:supportandreading=Support and further reading, + document:furtherreading=Further reading] + +\stopenvironment diff --git a/doc/context/sources/general/manuals/start/en/sounds-001.tex b/doc/context/sources/general/manuals/start/en/sounds-001.tex new file mode 100644 index 000000000..7d1428113 --- /dev/null +++ b/doc/context/sources/general/manuals/start/en/sounds-001.tex @@ -0,0 +1,34 @@ +\definerenderingwindow + [example] + [width=0pt,height=0pt,frame=off] + +\setupinteraction[state=start] + +\useexternalrendering + [mysound] + [audio/mpeg] % audio/x-mp3 + [akkerman.mp3] + [] + +\definereference [StartSoundTrack] [StartRendering{mysound}] +\definereference [StopSoundTrack] [StopRendering{mysound}] + +\definelayer[resources][width=\paperwidth,height=\paperheight] + +\setupbackgrounds[page][background=resources] + +\starttext + + \setlayer[resources]{\placerenderingwindow[example][mysound]} % once + + \startTEXpage + \button{start}[StartSoundTrack] + \button{stop}[StopSoundTrack] + \stopTEXpage + + \startTEXpage + \button{start}[StartSoundTrack] + \button{stop}[StopSoundTrack] + \stopTEXpage + +\stoptext |