Difference between revisions of "User talk:Koenich"

From Wiki
Jump to navigation Jump to search
 
(35 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
= NOTE =
+
= Preamble =
  
−
THIS SITE IS ONLY A MIRROR of [http://wiki.contextgarden.net/Textadept Textadept] created for editing purposes.
+
Here is the place to get everything that is important to get started with ''ConTeXt'' on ''MS Windows'' operating system.
  
−
< [[Text Editors]]
+
Thanks to especially ''Donald Knuth'', ''Hans Hagen'', ''Taco Hoekwater'' and too many other coders and users to mention here!
  
−
=Introduction=
+
= Introduction =
  
−
[https://foicica.com/textadept/ Textadept] is a programmable text editor for Linux, Mac OSX and Windows. It is fully extensible using [https://www.lua.org/ Lua].
+
[http://wiki.contextgarden.net ConTeXt] (pronounced '''ConTehht''' as derived from Dutch) is a [http://en.wikipedia.org/wiki/TeX TeX] macro package created and maintained by [http://www.pragma-ade.com Pragma ADE].
  
 +
= Setup ConTeXt =
  
−
= How to ConTeXt with Textadept (MS Windows) =
+
== Download & Install ConTeXt ==
−
(updated 2017/03)
 
  
−
== Step 1: Install / Update '''ConTeXt''' ==
+
Installation and update of ConTeXt work the same way. If you only want to update ConTeXt, you can go to point 3.
  
−
Installation and update of ConTeXt work the same way. If you only want to update ConTeXt you can start directly from point 1.3.
+
1. Download [http://standalone.contextgarden.net/setup/ ConTeXt].
 +
* [https://distribution.contextgarden.net/setup/context-setup-mswin.zip context-setup-mswin.zip]
  
−
1.1. [http://standalone.contextgarden.net/setup/ Download] ConTeXt.
+
2. Extract the archive to a location of your choice.
−
* Windows x86 / 32 bit users: [http://standalone.contextgarden.net/setup/context-setup-mswin.zip context-setup-mswin.zip]
 
−
* Windows x64 / 64 bit users: [http://standalone.contextgarden.net/setup/context-setup-win64.zip context-setup-win64.zip]
 
−
** Download the x64 / 64 bit version only when you are really sure, that you '''need''' it.
 
−
 
 
−
1.2. Extract the archive to a location of your choice.
 
 
* You might want to change the name of the extracted directory to a shorter one as it will be the final location for ConTeXt.
 
* You might want to change the name of the extracted directory to a shorter one as it will be the final location for ConTeXt.
  
 +
3. Install / Update ConTeXt
  
−
1.3. Install / Update ConTeXt
+
* Use Windows Explorer to navigate to your ConTeXt directory. In there should be a file called <code>install.bat</code>.
−
 
+
* Execute by double-clicking on it. A command prompt window should pop up.
−
 
 
−
1.3. Method 1: Write a batch file
 
−
 
 
−
Since at this point the installation and update of ConTeXt work the same way, the most effective solution is to create a batch file. To do so
 
−
 
 
−
* use Windows Explorer to navigate to your ConTeXt directory. In there should be a file called <code>first-setup.bat</code>.
 
−
* Use Windows Notepad or <code>Right-click</code> -> '''New''' -> '''Textfile''' to create such.
 
−
* If you only want ConTeXt mkiv (highly '''recommended'''), add the following line to the new and empty textfile:
 
−
  first-setup -engine=luatex -modules=all
 
−
* Save the file as a '''batch'''-file and name it something like <code>update.bat</code>.
 
−
** '''Note''' that the document ending has to be <code>.bat</code> not <code>.txt</code> or anything else. You might have to rename the file ending by hand.
 
−
* Execute the batch file you just created by double-clicking on it. A command prompt window should pop up.
 
 
** If it appears for only a few seconds, chances are high that the download server is down. In that case you might want to re-try the procedure at some other time.
 
** If it appears for only a few seconds, chances are high that the download server is down. In that case you might want to re-try the procedure at some other time.
 
* Wait for the download / update to finish. After it is done, the command window should disappear by itself.
 
* Wait for the download / update to finish. After it is done, the command window should disappear by itself.
−
** ConTeXt's folder's size should be around 380 - 400 MB when everything worked fine.
 
−
 
−
From here you can go to Step 2 directly.
 
−
 
  
−
1.3. Method 2: Type the command by hand
+
Alternatively, from the command prompt:
  
 
* Use Windows Explorer to navigate to your ConTeXt directory.
 
* Use Windows Explorer to navigate to your ConTeXt directory.
Line 53: Line 34:
 
** Enter <code>cmd</code> and press <code>Enter</code>-key.
 
** Enter <code>cmd</code> and press <code>Enter</code>-key.
 
** Now Windows command prompt should pop up with the correct location.
 
** Now Windows command prompt should pop up with the correct location.
−
* Otherwise you can start your Windows command prompt
+
* Otherwise, you can start your Windows command prompt
 
** by using the key shortcut <code>Windows-key + R</code>, entering <code>cmd</code> and pressing <code>Enter</code>-key.
 
** by using the key shortcut <code>Windows-key + R</code>, entering <code>cmd</code> and pressing <code>Enter</code>-key.
−
** Alternatively you can use <code>Start</code> -> <code>Programs</code> -> <code>Accessories</code> -> <code>Command Pompt</code>.
+
** Alternatively, you can use <code>Start</code> -> <code>Programs</code> -> <code>Accessories</code> -> <code>Command Pompt</code>.
−
* Some DOS commands you might need:
+
* Some important ''MS DOS'' commands:
 
** <code>dir</code> list the content of the current directory
 
** <code>dir</code> list the content of the current directory
 
** <code>cd DIRECTORY</code> change to directory with name DIRECTORY
 
** <code>cd DIRECTORY</code> change to directory with name DIRECTORY
Line 65: Line 46:
 
* In the end your command prompt should look like this:
 
* In the end your command prompt should look like this:
 
   X:\ConTeXt>_
 
   X:\ConTeXt>_
−
* If you only want ConTeXt mkiv (highly '''recommended'''), enter the following line and press <code>Enter</code>-key:
 
−
  first-setup -engine=luatex -modules=all
 
−
* Wait until the download / update is complete. Afterwards you can close the command prompt by entering <code>exit</code> and pressing <code>Enter</code>-key or by simply closing the window.
 
  
−
== Step 2: Add ConTeXt's executables folder to Windows search Path ==
+
== Add ConTeXt's executables folder to Windows search Path ==
  
−
'''Note''': you will need admin rights for this. On public machines for example you most probably won't be able to add ConTeXt to that machine's path. In that case skip this step and go to Step 3 respectively Step 4.1 directly.
+
'''Note''': you will need admin rights for this. On public machines for example you most probably won't be able to add ConTeXt to that machine's path.
  
−
2.1. Open Windows' '''System''' dialog
+
1. Open Windows' '''System''' dialog
 
* either by <code>Right-click</code>ing on '''This PC''' / '''My Computer''' on your Desktop and then clicking on '''Properties'''
 
* either by <code>Right-click</code>ing on '''This PC''' / '''My Computer''' on your Desktop and then clicking on '''Properties'''
 
* or by clicking '''Start''' -> '''Settings''' -> '''About''' -> '''System Info'''
 
* or by clicking '''Start''' -> '''Settings''' -> '''About''' -> '''System Info'''
 
* or on older Windows Machines by going to '''Control Panel''' -> '''System'''.
 
* or on older Windows Machines by going to '''Control Panel''' -> '''System'''.
  
−
2.2. Click on '''Advanced System Settings''' ("System Properties").
+
2. Click on '''Advanced System Settings''' ("System Properties").
  
−
2.3. Click on '''Advanced'''-Tab.
+
3. Click on '''Advanced'''-Tab.
  
−
2.4. Click on '''Environment Variables...'''.
+
4. Click on '''Environment Variables...'''.
  
−
2.5. Choose where to add ConTeXt's executables folder to:
+
5. Choose where to add ConTeXt's executables folder to:
 
*Either to '''User variables for USER''' for the current user only
 
*Either to '''User variables for USER''' for the current user only
 
*or to '''System variables''' for all users.
 
*or to '''System variables''' for all users.
  
−
2.6. Double-click on the respective variable called Path.
+
6. Double-click on the respective variable called ''Path''.
  
−
2.7. Add your ConTeXt executables to Windows path.
+
7. Add your ConTeXt executables to Windows path.
 
* '''Note''' that the position, to where you add the location is sorted by importancy. The most important directories will be searched first. This might be taken into account when using ConTeXt together with MiKTeX for example. It's safest to place ConTeXt's path at the very beginning.
 
* '''Note''' that the position, to where you add the location is sorted by importancy. The most important directories will be searched first. This might be taken into account when using ConTeXt together with MiKTeX for example. It's safest to place ConTeXt's path at the very beginning.
 
* In '''User''' Path variable you might need to add the location and seperate it from the existing ones by using a semikolon (<code>;</code>).
 
* In '''User''' Path variable you might need to add the location and seperate it from the existing ones by using a semikolon (<code>;</code>).
Line 102: Line 80:
 
   X:\ConTeXt\tex\texmf-win64\bin
 
   X:\ConTeXt\tex\texmf-win64\bin
  
−
2.8. Save your changes. Usually no restart or re-login is needed after this operation, but to make sure that the folder was added, you should restart your machine.
+
8. Save your changes. Usually no restart or re-login is needed after this operation.
  
−
Optional: You can test whether it worked by starting your Command prompt and entering the following line, while being in a directory other than the one you just added.
+
Opt 1. You can test whether it worked by starting your Command prompt and entering the following line, while being in a directory other than the one you just added.
  
 
   context -version
 
   context -version
  
 
* A message with ConTeXt's version number should apear.
 
* A message with ConTeXt's version number should apear.
−
* If a message like '''context' is not recognized as an internal or external command...'' appears, you should restart your machine, make sure that you added the correct location of ConTeXt's executables path to Window's search path or re-try the operation by starting from Step 2.1.
+
* If a message like '''context' is not recognized as an internal or external command...'' appears, you should make sure that you added the correct location of ConTeXt's executables (context.exe) path to Windows' search path.
−
 
 
−
== Step 3: Install '''Textadept''' ==
 
−
 
 
−
3.1. [https://foicica.com/textadept/download/textadept_LATEST.win32.zip Download] and extract [https://foicica.com/textadept/ '''Textadept'''] to a folder of your choice.
 
−
 
 
−
3.2. Use <code>textadept.exe</code> from the extracted folder to start Textadept.
 
−
 
 
−
== Step 4: Tweak '''Textadept''''s settings ==
 
−
 
 
−
'''Note''' that almost all changes to Textadept are saved in the file <code>init.lua</code>. There is two of them, of which you should edit only one:
 
−
 
 
−
* One of them is in the extracted Textadept main folder. It is '''not recommended''' to edit this file as your changes will be lost when you update Textadept. Instead:
 
−
* When you start Textadept for the first time, a new folder  <code>SYSDRIVE:\users\USERNAME\.textadept</code> gets created. It also contains a file called <code>init.lua</code>. This is the file and location where you should save all your Textadept settings. This way you can make a copy and use it on several computers. When you open it for the first time it should be empty.
 
−
 
 
−
Usually you have to restart Textadept after changing its configuration files. Robert Gieseke created a code though, which you can add to your <code>init.lua</code> to circumvent having to restart Textadept whenever a change is made:
 
−
 
 
−
  -- Save and reset Lua state: `F9`
 
−
  keys['f9'] = function()   -- Mac OSX users might prefer:    keys[OSX and 'mf9' or 'f9']
 
−
    io.save_file()
 
−
    reset()
 
−
  end
 
−
 
 
−
Save <code>init.lua</code> and restart Textadept once. After doing so you can add changes to Textadept's configuration files and press <code>F9</code>-key afterwards to save and load the changes without having to restart Textadept.
 
−
 
 
−
=== Step 4.1: Bind a PDF build command into Textadept ===
 
−
 
 
−
4.1.1. Use Textadept to open your <code>init.lua</code> stored in <code>SYSDRIVE:\users\USER\.textadept\</code>.
 
−
 
 
−
4.1.2. Add an execute command for ConTeXt to Textadept's menu:
 
−
* If your ConTeXt executables folder is already in the Windows search Path:
 
−
  textadept.run.compile_commands.tex = 'mtxrun --autogenerate --script context --autopdf --purge --synctex=-1 "%f"'
 
−
* If for some reason you can't add the folder to PATH, for example on public machines, you have to add the full path to your ConTeXt executables. For example:
 
−
  textadept.run.compile_commands.tex = 'C:/ctx/tex/texmf-mswin/bin/mtxrun --autogenerate --script context --autopdf --purge --synctex=-1 "%f"'
 
−
* '''Important''': you have to start `first-setup.bat` from the main ConTeXt directory every time you restart a machine, on which ConTeXt is not in the Windows search path (see Step 1.3), otherwise you will get ''file not found''-errors, when trying to compile a ConTeXt document.
 
−
* '''Note''' that you have to use slash <code>/</code> instead of backslash <code>\</code> in the file path, since Lua (same as ConTeXt) interprets a <code>\</code> as the beginning of a command.
 
−
 
 
−
4.1.3. Restart Textadept to reload the modified <code>init.lua</code>.
 
−
 
 
−
4.1.4. Open or create a ConTeXt test document:
 
−
  \starttext
 
−
    hello world!
 
−
  \stoptext
 
−
 
 
−
4.1.5. Use Textadept's '''Tools''' -> '''Compile''' to build a PDF with the options added to <code>init.lua</code>. A message buffer with compilation status will open in a seperate tab.
 
−
 
 
−
4.1.6. When you have a popular PDF reader installed already, it should pop up at the end of the process and show the created PDF output. [https://www.sumatrapdfreader.org/free-pdf-reader.html '''Sumatra PDF'''] is highly recommended for this.
 
−
 
 
−
=== Step 4.2: Lexing (command highlighting & code folding) ===
 
−
 
 
−
A lexer is a file that defines command highlighting and code folding keywords. Textadept comes with a ConTeXt lexer. In order to be able to use command highlighting and code folding when writing ConTeXt documents, you have to bind those documents to the lexer. To do so
 
−
 
 
−
4.2.1. add the following line to your <code>USER/.textadept/init.lua</code> and save it afterwards:
 
−
  textadept.file_types.extensions.tex = 'context'
 
−
* If you plan to use LaTeX and ConTeXt, you might want to use different file extensions for each format. For example <code>*.tex</code> for LaTeX and <code>*.cxd</code> for ConTeXt documents. In that case you only have to bind your new ConTeXt extension to Textadept's ConTeXt lexer, since <code>.tex</code> files are automatically recognized as LaTeX documents:
 
−
  textadept.file_types.extensions.cxd = 'context'
 
−
** When linking files within ConTeXt documents without adding an extension though, ConTeXt will expect those files to have the ending <code>*.tex</code>, i.e. you will have to work with filenames and extensions when using a format other than <code>*.tex</code>, which on the other hand should not be seen as a disadvantage. (TODO: which way is more "hack proof"?)
 
−
 
 
−
4.2.2. Restart Textadept to reload <code>init.lua</code>.
 
−
 
 
−
4.2.3. Open a ConTeXt document and check Textadept's status bar in the lower right corner. It should say '''context'''. If it says '''latex''' make sure it really is a ConTeXt file or repeat the procedure.
 
−
 
 
−
== Optional: Additional '''Textadept''' tweaks ==
 
−
 
 
−
=== Themes & editor font changes ===
 
−
You can change the theme, font and font size of Textadept with the following line
 
−
  ui.set_theme('dark', {font = 'Monospace', fontsize = 10})
 
−
in which the expression '''dark''' is the filename of the theme located either in <code>Textadept\themes</code> or you can download and add new themes to <code>USER\.textadept\themes</code>
 
−
(create the folder if it's not there yet).
 
−
 
 
−
* Many ''base16'' themes for Textadept can be found at [https://github.com/rgieseke/textadept-themes Robert Gieseke's GitHub]. You can preview them [https://termux.com/add-on-styling-color-preview.html here] or [https://chriskempson.github.io/base16/ here] (partially).
 
−
 
 
−
* There are more settings which you can look up in Textadept's [https://foicica.com/textadept/manual.html#Themes manual].
 
−
 
 
−
=== Snippets ===
 
−
Snippets are predefined code or text blocks. Using snippets can save a lot of time as you won't have to retype often used commands and text passages. You add snippets to your <code>USER/.textadept/init.lua</code>. In Textadept snippets look like this:
 
−
  snippets.context['TRIGGERKEYWORD'] = 'PASTEDTEXT'
 
−
 
 
−
To get an idea how writing snippets (for ConTeXt) works, you can copy and paste the following list to your <code>init.lua</code>:
 
−
 
 
−
  -- The first line is mandatory:
 
−
  snippets['context'] = snippets['context'] or {}
 
−
  -- Snippets start here:
 
−
  snippets.context['emph']        = '{\\em %<selected_text>%0}' -- emphasized text/math
 
−
  snippets.context['ital']        = '{\\it %<selected_text>%0}' -- italic text/math
 
−
  snippets.context['bold']        = '{\\bf %<selected_text>%0}' -- bold text/math
 
−
  snippets.context['bold']        = '{\\bi %<selected_text>%0}' -- bold italic text/math
 
−
  snippets.context['start']      = '\\start%1\n\t%0\n\\stop%1'
 
−
  snippets.context['itemize']    = '\\startitemize[packed]\n\t\\startitem\n\t\t%<selected_text>%0\n\t\\stopitem\n\\stopitemize' -- start itemization
 
−
  snippets.context['item'] = '\\startitem\n\t%<selected_text>%0\n\\stopitem'
 
−
  snippets.context['enumerate']  = '\\startenumerate\n\t%0\n\\stopenumerate'
 
−
  snippets.context['chapter']    = '\\startchapter[title={%1},marking{%1}]\n\t%0\n\\stopchapter'
 
−
  snippets.context['section']    = '\\startsection[title={%1},marking{%1}]\n\t%0\n\\stopsection'
 
−
  snippets.context['ssection']    = '\\startsubsection[title={%1},marking{%1}]\n\t%0\n\\stopsubsection'
 
−
  snippets.context['title']      = '\\starttitle[title={%1},marking{%1}]\n\t%0\n\\stoptitle'
 
−
  snippets.context['subject']    = '\\startsubject[title={%1},marking{%1}]\n\t%0\n\\stopsubject'
 
−
  snippets.context['ssubject']    = '\\startsubsubject[title={%1},marking{%1}]\n\t%0\n\\stopsubsubject'
 
−
 
 
−
* '''Note''' that a backslash <code>\</code> is set by typing a double backslash <code>\\</code>.
 
−
 
 
−
* The most important formatting commands are the following:
 
−
**<code>\n</code> set a line break (new line)
 
−
**<code>\t</code> set a tabulated
 
−
**<code>%0</code> set the ''closing'' caret (placeholder) (the cursor will jump here '''last''')
 
−
**<code>%1</code> set one or multiple input carets (<code>%1</code>, <code>%2</code>, <code>%3</code> and so on; you can also use the same integer multiple times: e.g. <code>\\start%1 ... \\stop%1</code>)
 
−
**<code>%<selected_text></code> this is where highlighted text will be pasted when enclosing it with a snippet (e.g. <code>{\\bi %<selected_text>%0}</code>)
 
−
 
 
−
* After adding snippets, you have to restart Textadept or reset Lua state as described in Step 4.
 
−
 
 
−
* You can paste snippets into ConTeXt documents
 
−
** either by typing the keyword that you defined within <code>snippets.context['KEYWORD']</code> and pressing <code>Tab</code>-key afterwards
 
−
** or by using <code>Ctrl + K</code> (by default on Windows machines) to choose from the list of snippets. No matter in which order you add them to your <code>init.lua</code>, they will show up sorted alphabetically.
 
−
*** You can turn off alphabetical sorting of snippets by adding the following line to your <code>init.lua</code>:
 
−
 
 
−
  TODO
 
−
 
 
−
* '''Note''' that since this way you bound snippets to Textadept's ConTeXt lexer, Textadept's status bar in the lower right corner has to say '''context''', otherwise use a ConTeXt document or see Step 4.2.
 
−
 
 
−
* Read more about snippets in Textadept's [https://foicica.com/textadept/api.html#textadept.snippets manual].
 
−
 
 
−
 
 
−
=3rd party projects=
 
−
 
 
−
A ConTeXt module for Textadept is being developed at [https://github.com/stephengaito/ta-context-latex ta-context-latex].
 
−
 
 
−
Note though, that if you plan to use Textadept without LaTeX with ConTeXt mkiv only (recommended), then you might not need the package mentioned above as it comes with literally only a hand full of ConTeXt snippets. It also needs additional software to be installed (Textredux, ctags), so that it's almost more comfortable to create own ConTeXt snippets with the ease of Textadept (see above).
 
−
 
 
−
= NOTE =
 
  
−
THIS SITE IS ONLY A MIRROR of [http://wiki.contextgarden.net/Textadept Textadept] created for editing purposes.
+
= Text Editors =
 +
== ''CudaText'' ==
 +
See my article here [[CudaText]].

Latest revision as of 06:52, 10 September 2023

Preamble

Here is the place to get everything that is important to get started with ConTeXt on MS Windows operating system.

Thanks to especially Donald Knuth, Hans Hagen, Taco Hoekwater and too many other coders and users to mention here!

Introduction

ConTeXt (pronounced ConTehht as derived from Dutch) is a TeX macro package created and maintained by Pragma ADE.

Setup ConTeXt

Download & Install ConTeXt

Installation and update of ConTeXt work the same way. If you only want to update ConTeXt, you can go to point 3.

1. Download ConTeXt.

2. Extract the archive to a location of your choice.

  • You might want to change the name of the extracted directory to a shorter one as it will be the final location for ConTeXt.

3. Install / Update ConTeXt

  • Use Windows Explorer to navigate to your ConTeXt directory. In there should be a file called install.bat.
  • Execute by double-clicking on it. A command prompt window should pop up.
    • If it appears for only a few seconds, chances are high that the download server is down. In that case you might want to re-try the procedure at some other time.
  • Wait for the download / update to finish. After it is done, the command window should disappear by itself.

Alternatively, from the command prompt:

  • Use Windows Explorer to navigate to your ConTeXt directory.
    • Click into the upper white field where the current location is displayed.
    • Enter cmd and press Enter-key.
    • Now Windows command prompt should pop up with the correct location.
  • Otherwise, you can start your Windows command prompt
    • by using the key shortcut Windows-key + R, entering cmd and pressing Enter-key.
    • Alternatively, you can use Start -> Programs -> Accessories -> Command Pompt.
  • Some important MS DOS commands:
    • dir list the content of the current directory
    • cd DIRECTORY change to directory with name DIRECTORY
    • cd.. change to superior directory
    • cd\ change to drive root
    • X: change to drive X:
    • also possible: cd directory\subdirectory\subsubdir...
  • In the end your command prompt should look like this:
 X:\ConTeXt>_

Add ConTeXt's executables folder to Windows search Path

Note: you will need admin rights for this. On public machines for example you most probably won't be able to add ConTeXt to that machine's path.

1. Open Windows' System dialog

  • either by Right-clicking on This PC / My Computer on your Desktop and then clicking on Properties
  • or by clicking Start -> Settings -> About -> System Info
  • or on older Windows Machines by going to Control Panel -> System.

2. Click on Advanced System Settings ("System Properties").

3. Click on Advanced-Tab.

4. Click on Environment Variables....

5. Choose where to add ConTeXt's executables folder to:

  • Either to User variables for USER for the current user only
  • or to System variables for all users.

6. Double-click on the respective variable called Path.

7. Add your ConTeXt executables to Windows path.

  • Note that the position, to where you add the location is sorted by importancy. The most important directories will be searched first. This might be taken into account when using ConTeXt together with MiKTeX for example. It's safest to place ConTeXt's path at the very beginning.
  • In User Path variable you might need to add the location and seperate it from the existing ones by using a semikolon (;).
  • In System Path variable you probably only have to add a new line.

The location should look like this:

  • Win x86 / 32 bit:
 X:\ConTeXt\tex\texmf-mswin\bin
  • Win x64 / 64 bit:
 X:\ConTeXt\tex\texmf-win64\bin

8. Save your changes. Usually no restart or re-login is needed after this operation.

Opt 1. You can test whether it worked by starting your Command prompt and entering the following line, while being in a directory other than the one you just added. 

 context -version
  • A message with ConTeXt's version number should apear.
  • If a message like 'context' is not recognized as an internal or external command... appears, you should make sure that you added the correct location of ConTeXt's executables (context.exe) path to Windows' search path.

Text Editors

CudaText

See my article here CudaText.

Retrieved from "https://wiki.contextgarden.net/index.php?title=User_talk:Koenich&oldid=34024"