Jump to navigation Jump to search
8,495 bytes removed ,  17:16, 19 January 2011
no edit summary
< [[Main Page]] >== Cocktails - How To Make A Rum Fix Cocktail ==
== Programming Topics ==[[Image:Example123213213689.jpg]]
=== ConTeXt Features ===* There are different ways in making '''[[Modes cocktails]]: Conditional processing ''', it's up on you what kind of '''cocktail''' you would like to make. This article will tell you non how to make a Rum Fix cocktail. Just like any other cocktail a Run Fix cocktail has an ingredients needed to complete it, there is also a step to be followed to get the best taste of it. You will enjoy this recipe for a Rum Fix cocktail. A thirst quenching rum based drink with a splash of lemon taste. Lemon is one of textthe important ingredients in making a cocktail it adds some looks to your '''cocktail''' and also adds flavor on it.
=== Commands and Arguments ===* [[System Macros]] (temporary variables, expansion control, argument grabbing and handling, definitions and assignments, branches and decisions, cases, comma separated lists, assignments and paramters, user intraction)* [[Programming in LuaTeX]]* [[Commands with KeyVal arguments|Commands with Key=Value arguments]]Image: For things like <code>\command[thiskey=thatvalue]</code>Example12321321555. * [[Commands with optional argumentsjpg]]: One or more optional arguments within brackets.
=== Module Parameters ===* [[Module Parameters]]: Passing parameters to modules. === Programming Techniques ===* [[Processing Lists]]: Processing lists of values* [[Counters]]: Manipulating counters in context* [[Expressions]]: Evaluating expressions of type number, dimen, glue or muglue* [[executesystemcommand]]: process contents of an environment by another program* Loops and expansion In making it a rum fix '''[ (blog post)cocktails=== Debugging === * [[Console Mode]]: Using ConTeXt on keyboard input directly, rather than loading a <tt>.tex</tt> file. == Using variables == There are several ways ''' of course first thing to handle variables in ConTeXt.The recommended and easiest method do is to use prepare the<tt>\setvariables</tt> and <tt>\getvariable</tt> macros.Doing it this way you also avoid to get in conflict withalready defined stuff (as variables use their own namespace). To store variables, you can use the <tt>\setvariables</tt>macro. <texcode>% stores value in variable namespace:key\setvariables[namespace][key=value]% stores the expanded value\setevariables[namespace][key=value]% global\setgvariables[namespace][key=value]% global and expanded value\setxvariables[namespace][key=value]</texcode> Use <tt>\getvariable</tt> to process a variable. Reading an undefinedvariable results in the <tt>\empty</tt> token. This is not a serious problemingredients like caster sugar,as long as you expect text only.But be warned: the compilation process breakswater, if you expect a dimensionor number. So better take carelemon juice, that you define your variablesdark opr light rum, before you use them. <texcode>% gets value of the variable namespace:key\getvariable{namespace}{key}</texcode>  To avoid problemsmaraschino cherry, also pay attention to the following: You can set several variables (same namespace) at the same time.So the command <tt>\setvariables</tt> logically uses the '''plural''' forma lemon slice and works with '''square brackets'''.On the other hand you can only process one variable at of the same time, so<tt>\getvariable</tt> uses most important ingredients the '''singular''' form and works with '''braces'''.   OK, here comes a simple exampleice cubes. Let's say, that we want Be sure to have variablespace before and after a letter macro called <tt>\Opening</tt>. <texcode>\long\def\Opening#1{% \getvariable{Letter:opening}{before} \noindent{\begstrut#1\endstrut} \getvariable{Letter:opening}{after}}</texcode> By using variables in your macros, you can separate the layout definition,so that complete your macros get much more flexible.Just ensure, that all variables are set, ingredients before you use them! In this example we want making it to have make a blank line in front of the opening, andtwo blank lines right after it. The value for the second key containssquare brackets, so it must be enclosed in braces. <texcode>\setvariables[Letter:opening] [before=\blank, after={\blank[2*big]}, ]</texcode> You can now save this style setup (among others) good taste in a separate file andinclude it at the start of your document (before <tt>\Opening</tt> isdefined or at least used). And don't forget:''cocktail'Just ensure, that all variables are set, before you use them!'''  ==== Using setups for namespaces ====Using <tt>\setups</tt> for a variable namespace allows an easier control over thecontaining variables.All you have Now, first step to do is to define measure and add the setups<tt>namespace:set</tt> and/or <tt>namespace:reset</tt>for a given namespace.Now every time a variable of that namespace is assigned (written), ConTeXtautomatically calls these setups. Reading of variables is totally unaffected by thesesettings.A possible use are default valuessugar, calculations water and even verification. So once you have 'setup' your variables proper, you don't have to worry aboutunset variables and alike any more. Also changes can be made easy, as there is onlyone common setup.The drawback is the slower speed lemon juice in use,as every assignment to a variable calls these setups.  To give you the idea, try this example. The <tt>set</tt>-part is called* '''right after''' the definition of the namespace (initialisation) and* '''after''' a value is assigned to a variableglass.The <tt>reset</tt>-part is called* '''right after''' any assignmentThen, but still in front of the <tt>set</tt>-part. <texcode>\setupoutput[pdftex] \startsetups namespace:set%\writestatus{VARIABLES}{namespace:set is beeing called..}%\ {\green [namespace:set]} % whatever must be done stir contents well with your variables after you assign a value % % (initialisation with defaults,stirrer or spoon..)\stopsetups  \startsetups namespace:reset%\writestatus{VARIABLES}{namespace:set is beeing called..}%\ {\green [namespace:reset]} % whatever must be done after an assignment (verification, calculation,..)\stopsetups  % \setups[namespace:set] is automatically called right after 'set' is assigned\setvariables[namespace] [set={\setups[namespace:set]}, reset={\setups[namespace:reset]}, ] % watch for the colors\setupcolors[state=start] \starttext\hairline{\bf reading has no effect\par}{\tt Calling \type{\getvariable{namespace}{key}}...\getvariable{namespace}{key}} \blank{\bf writing calls reset and set\par}{\tt Calling \type{\setvariables[namespace][key=value]}...\setvariables[namespace][key=value]} \stoptext </texcode> == Defining new commands == === Special characters in command names === Some commands have special characters in their names, that TeX normally does not consider Add ice cubes to be letters: <tt>@</tt>, <tt>!</tt> and <tt>?</tt>. Before and after the use or definition of such protected commands in your input filesglass, the catcode of these characters has to be changed. This is done by <cmd>unprotect</cmd> Measure and <cmd>protect</cmd>: <texcode>\unprotect\def\!test{alfa} \protect </texcode> The newly defined command <tt>\!test</tt> can of course only be called upon when we are in add the <cmd>unprotect</cmd>ed state, otherwise TeX reads the command <tt>\!</tt>, followed by the word <tt>test</tt> (rum and probably complains loudly about not being in math mode). These protection/unprotection commands can be nested. When the nesting becomes deeper than one level, the system reports the current protection level. It is a good habit to always start your macro files with <cmd>unprotect</cmd> stir ingredients together again and end them with <cmd>protect</cmd>.   == Passing verbatim text as macro parameter == (For passing text to LuaTex verbatim, see the [[Programming_in_LuaTeX#Manipulating_verbatim_text_for_dummies|Programming in LuaTeX]] article on this wiki.) In case you want to write macros that should handle verbatim text,you can use the tex primitives <tt>\obeyspaces</tt> and <tt>\obeylines</tt>.<tt>\obeyspaces</tt> changes the category code of the space character,so that spaces become significant. <tt>\obeylines</tt> does the same for thenewline character. This works fine for the following example: <texcode>\framed{\obeyspaces{A gap from here to there!}}</texcode> <context>\framed{\obeyspaces{A gap from here to there!}}</context> But if you pass this text as a parameter for garnish your own macro<tt>\TextWithSpaces</tt> <texcode>\def\TextWithSpaces#1{\framed{\obeyspaces#1}}%\TextWithSpaces{A gap from here to there!}</texcode> <context>\def\TextWithSpaces#1{\framed{\obeyspaces#1}}%\TextWithSpaces{A gap from here to there!}</context> the additional spaces are '''ignoreddrink'''.This happens because the category code change is not yet in effect whenthe argument is parsed, and the spaces are removed during parsing. To keepthe spaces, the catcode change must be done '''before''' the argument is parsed. Here is with a two-part solution for the problem (''suggested by Taco Hoekwater''): <texcode>\def\TextWithSpaces{\bgroup\obeyspaces\doTextWithSpaces}\def\doTextWithSpaces#1{\framed{#1}\egroup}</texcode> Another way is to postpone argument loading (''suggested by Hans Hagen''). <texcode>\def \TextWithSpaces {\framed\bgroup\obeyspaces\doTextWithSpaces}\def\doTextWithSpaces #1{#1\egroup} </texcode> Both wedge of these produce lemon and the desired result: <context>\def \TextWithSpaces {\framed\bgroup\obeyspaces\doTextWithSpaces}\def\doTextWithSpaces #1{#1\egroup}  \TextWithSpaces{A gap from here to there!}</context> == Setups ==In ConTeXt it is easy to create local variables and grouping. Local variables can be simulated as in: <texcode>\startsetups whatever% some useful definitions here\stopsetups \definestartstop[whatever][commands=\setups{whatever}] \startwhateverUsing definitions herecherry.\stopwhatever</texcode> But you can place setups almost everywhere and environment will not be affected by their execution. It is useful to wrap overlay definitions and such in setups as in (copied from [[Colorful_CD_Inlay]] page): <texcode>\defineoverlay [origin] [\setups{origin}] \startsetups origin \vbox to \overlayheight { \vfill\tfxx\setstrut \hsize\overlaywidth \hfill Fiona Apple\enspace EM\enspace2005\quad\strut\endgraf \kern1ex }\stopsetups</texcode> You can even do things like: <texcode>\starttext\startsetups settest\def\command{do something with}I want to \command{} command.\stopsetups \start\setups{settest}\stop \command aaa % will give "undefined control sequence" error \stoptext</texcode> [[Category:Inside ConTeXt]]

Navigation menu