summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/vntex/tests/README
blob: e65fb09a73308773a2b60f1c9a57d6aef0211e31 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
vntex-3.02

Copyright 2003-2005 Han The Thanh <HanTheThanh@gmx.net>
	  	and Reinhard Kotucha <Reinhard.Kotucha@web.de>.
This file is part of vntex.  License: LPPL, version 1.3 or newer,
according to http://www.latex-project.org/lppl.txt

For installation instructions see http://vntex.org/

This directory contains some TeX files to test the functionality
of vntex, as well as to create vietnamese font samples.


Makefile
========
There is a Makefile which can be used to compile the test files and
font samples.  Usage information is provided in the Makefile
itself.  You have to edit the top of the file for customization.
If it doesn't work for you, instructions are given below how you can
compile the test files manually.


Test Files
==========
test-vietnam.tex:       test of Vietnamese support in LaTeX using
                        vietnam.sty and inputenc

test-vietnam-tcx.tex:   test of Vietnamese support in LaTeX using
                        vietnam.sty and TCX

test-babel.tex:         test of Vietnamese support in LaTeX using
                        babel and inputenc

test-plain.tex:         test of Vietnamese in plain using plainenc

test-plain-tcx.tex:     test of Vietnamese in plain using TCX


What is tcx?
------------ 
  TCX is an extension that allows translation of input encoding. The 
  advantage over using inputenc is that it allows vietnamese text in
  logging messages instead of TeX's hexadecimal representation (^^ab).

  The disadvantage is that it is not portable (TCX is web2c-specific),
  it allows only one input encoding in a single document and utf8 is 
  not supported. If you don't mind those carets in logging messages,
  simply use inputenc.

  It is impossible to use utf8 with plain; to do so an extension
  called enctex by Petr Olsak is required. However so far nobody
  ever asked for plain TeX support.

-------------------------------------------------------------
If tcx is not supported by your system, just ignore the files
  test-vietnam-tcx.tex
and
  test-plain-tcx.tex
-------------------------------------------------------------

There are also some other files that are included by the
above test files:

test-accents.tex:       test of accent commands
test-captions.tex:      test of Vietnamese captions
test-tcvn.tex:          test of TCVN input encoding
test-viscii.tex:        test of VISCII input encoding
test-utf8.tex:          test of UTF8 input encoding


To compile the test files, run:

pdflatex test-vietnam
pdflatex -parse-first-line test-vietnam-tcx
pdflatex test-babel
pdftex test-plain
pdftex -parse-first-line test-plain-tcx

(or use tex/latex instead of pdftex/pdflatex)

Run latex/pdflatex twice to get a table of cotents.


Font samples
============
All font sample files require vnsample.sty.

vnr-test.tex:            quick test of vnr fonts
vnr-sample.tex:          sample of vnr fonts

t5lm-test.tex:           quick test of lmodern fonts
t5lm-sample.tex:         sample of lmodern fonts

urwvn-test.tex:          quick test of urwvn fonts
urwvn-sample.tex:        sample of urwvn fonts

chartervn-test.tex	 quick test of charter fonts
chartervn-sample.tex     sample of charter fonts

t5antt-test.tex:         quick test of antt fonts
t5antt-sample.tex:       sample of antt fonts

t5iwona-test.tex         quick test of iwona fonts
t5iwona-sample.tex       sample of iwona fonts

t5kurier-test.tex        quick test of kurier fonts
t5kurier-sample.tex      sample of kurier fonts

mscore-test.tex:         quick test of mscore fonts
mscore-sample.tex:       sample of mscore fonts


These sample files use LaTeX, and require certain packages
to compile.  To compile these font samples, of course, the
corresponding font package must be installed as well. 

If you do not have all the required files installed, you can
download the samples as PDF files from

   http://vntex.org/fontsamples

Run pdflatex twice to get bookmarks.  Some of the sample files 
are very large and bookmarks will be helpful.

Some of the sample files require a vast amount of memory.
If you have a web2c based system (look whether you have 
a file `texmf.cnf' somewhere), you have to set the environment
variable 

  font_mem_size=1200000

Linux, UNIX, Mac OS X:
----------------------
  Either set it in the current shell:

    font_mem_size=1200000; export font_mem_size
    pdflatex vnrsample.tex

  or for a single process:

    env font_mem_size=1200000 pdflatex vnrsample.tex
    
Windows:
--------
    set font_mem_size=1200000
    pdflatex vnrsample.tex

MikTeX:
-------
    Edit the file MIKTEX.INI.  Look for a line beginning with
    "font_mem_size=" and set the value to at least 1200000.
    
Systems not based on web2c:
---------------------------
    Read the manual of your TeX system to find out how to 
    increase font_mem_size.  If it is not explained in the
    manual, maybe memory is allocated dynamically and you
    don't have to do anything. In this case, just try

    pdflatex vnrsample.tex
    
----------------------------------------------------------
Please note that you do not have to increase font_mem_size
to use vntex, the huge amount of memory is needed for the 
font samples only.
----------------------------------------------------------