Difference between revisions of "Improving the manuals"

From ConTeXt wiki
Jump to navigationJump to search
(remove all references to the defunct supelec.fr sources)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
The source code repository for the '''ConTeXt reference manual''' and
 
'''ConTeXt: an excursion''' is kept at
 
{{Domain|https://foundry.supelec.fr/projects/contextman}}. This article
 
explains how to access the source code.
 
  
== The contents of the repository ==
+
=== ConTeXt, an excursion ===
  
There are three directories at the top level of the repository:
+
There are several translations underway (Chinese, French, Vietnamese) for ''ConTeXt, an excursion'', as well as several [[ConTeXt, an excursion#Translations|completed translations]] (Czech, Dutch, English). To start a new translation, follow these instructions. First, the preliminaries:
 
 
* `context-beginners` contains the code for ''ConTeXt: an excursion'', the beginners' manual.
 
* `context-reference` contains the code for the ''ConTeXt reference manual''.
 
* `context-commands` contains a proof-of-concept for a command reference based on Lua tables. This project is not currently active.
 
 
 
Each manual's directory contains a Makefile; to build the PDF, the following should suffice (''mutatis mutandis'').
 
 
 
  cd context-reference
 
  make
 
 
 
''ConTeXt: an excursion'' is available in several languages, stored in `context-beginners/en/`, `context-beginners/fr/`, etc. A number of extra `make` targets are available:
 
 
 
  make en          # make only the english screen and print versions
 
  make fr-screen  # make only the french screen version
 
 
 
== Getting the source code ==
 
 
 
The source code is stored and managed using Subversion. For more information, see the [[Subversion]] article on this wiki.
 
 
 
=== Anonymous checkout, for curiosity ===
 
 
 
(Instructions taken from [https://foundry.supelec.fr/scm/?group_id=22 here].)
 
 
 
If you just want a copy of the manuals' source code, you can get it anonymously. Open a command prompt and enter the following command:
 
 
 
  svn checkout --username anonsvn https://foundry.supelec.fr/svn/contextman/
 
 
 
The password is `anonsvn`.
 
 
 
=== Non-anonymous checkout, for development ===
 
 
 
# [https://foundry.supelec.fr/account/register.php Register an account] on foundry.supelec.fr.
 
# [https://foundry.supelec.fr/project/request.php?group_id=22 Request to join] the `contextman` project
 
# Check out the source code using your developer name and password
 
 
 
  svn checkout --username ''developername'' https://foundry.supelec.fr/svn/contextman/
 
 
 
== Translating ConTeXt, an excursion ==
 
 
 
First, the preliminaries:
 
  
 
* follow the instructions above to make a non-anonymous checkout of the source.
 
* follow the instructions above to make a non-anonymous checkout of the source.
 
* Choose an abbreviation LANG for your language (e.g. `it` for Italian).
 
* Choose an abbreviation LANG for your language (e.g. `it` for Italian).
  
Next, create the required files.
+
Next, make your own language's files based on the English files.
  
 
* Create a subdirectory LANG.
 
* Create a subdirectory LANG.
Line 62: Line 18:
 
* Run `make LANG`
 
* Run `make LANG`
  
Then, it is time to start working on the translation.
+
Then it is time to start working on the translation.
  
 
* Comment each paragraph, and add your translation below it.
 
* Comment each paragraph, and add your translation below it.
  
When you are done, post a message to the [[Mailing list|mailing list]] announcing your finished translation. It will be put up in the official download locations.
+
When you are done, post a message to the [[Mailing list|mailing list]] announcing your finished translation. It will be made available in the official download locations.

Latest revision as of 08:54, 11 February 2019

ConTeXt, an excursion

There are several translations underway (Chinese, French, Vietnamese) for ConTeXt, an excursion, as well as several completed translations (Czech, Dutch, English). To start a new translation, follow these instructions. First, the preliminaries:

  • follow the instructions above to make a non-anonymous checkout of the source.
  • Choose an abbreviation LANG for your language (e.g. it for Italian).

Next, make your own language's files based on the English files.

  • Create a subdirectory LANG.
  • Copy all English files here: cp en/* LANG/.
  • In the file names, change any en segments to LANG.

Prepare the Makefile, so that anyone can compile your translation in a single step.

  • Open the Makefile. Add your own language alongside the existing languages — a simple copy-and-modify strategy should get you there.
  • Run make LANG

Then it is time to start working on the translation.

  • Comment each paragraph, and add your translation below it.

When you are done, post a message to the mailing list announcing your finished translation. It will be made available in the official download locations.