summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/xstring/README
blob: e0e96d9f9f0f7b76da7b17277fe34a5bb36f38d9 (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
                              _________________

                               xstring package
                                     v1.3
                                 2008/09/21
                              _________________

----------------------------------------------------------------------------
                                    Warning!
This package does not require LaTeX (although eTeX is still required).
Consequently, the xstring.tex file should be installed in the tex/ subtree.
----------------------------------------------------------------------------
This package provides macros manipulating strings, such as:
  * tests:
     - does a string contains at least n times an another?
     - does a string starts (or ends) with another? etc.
     - is a string an integer? A decimal?
     - are 2 strings equal?
     - is a string equal to several cases?
  * extractions of substrings:
     - what is on the left (or the right) of the nth occurrence of a
       substring;
     - what is between the occurrences of 2 substrings;
     - substring between 2 positions;
     - split a string, etc.
  * substitution of all (or the n first) occurrences of a substring
    for an other substring;
  * calculation of numbers:
     - length of a string;
     - position of the nth occurrence of a substring;
     - how many times a string contains a substring?
     - comparison of strings: position of the first difference.

For programming purposes, other macros allow to use special characters
(& ~ \ { } _ # $ ^ %) with the macros manipulating strings.

This bundle contains :
  * xstring.sty (the sty file for LaTeX)
  * xstring.tex (the package itself)
  * xstring_doc_en.tex and xstring_doc_en.pdf (manual in english)
  * xstring_doc_fr.tex and xstring_doc_fr.pdf (manual in french)
  * test_etex.tex and test_etex.pdf (test file to compile with etex)
  * test_latex.tex and test_latex.pdf (test file to compile with LaTeX)
  * README (this file)

#######################################################################
#######################################################################

----------------------------------------------------------------------------
                                    Attention !
Cette extension ne nécessite pas LaTeX (bien que eTeX soit toujours requis).
Par conséquent, le fichier xstring.tex devrait être installé dans le sous
répertoire tex/.
----------------------------------------------------------------------------
Cette extension regroupe un ensemble de macros manipulant des chaînes
de caractères :
  * des tests :
     - une chaîne en contient elle une autre au moins n fois ?
     - une chaîne commence t-elle ou finit-elle par une autre ? etc.
     - une chaîne est-elle un entier relatif ? Un décimal ?
     - deux chaînes sont-elles égales ?
     - une chaîne est elle égale à plusieurs cas ?
  * des extractions de chaines :
     - renvoi de ce qui se trouve avant (ou après) la nieme occurrence
       d'une sous-chaîne;
     - renvoi de ce qui se trouve entre les occurrences de 2 sous-chaînes;
     - sous-chaîne comprise entre 2 positions;
     - coupure d'une chaîne, etc.
  * le remplacement de toutes ou des n premières occurrences d'une
    sous-chaîne par une autre sous-chaîne;
  * des calculs de nombres :
     - longueur d'une chaîne;
     - position de la la nieme occurrence d'une sous-chaîne;
     - comptage du nombre d'occurrences d'une sous-chaîne dans une autre.
     - comparaison de 2 chaînes : position du 1er caractère différent.

D'autres commandes permettent  de traiter les caractères spéciaux
(& ~ \ { } _ # $ ^ %) de façon à les utiliser dans les arguments des macros
de ce package, ce qui permet d'utiliser ces macros à fins de programmation.

Ce paquet contient :
  * xstring.sty (le fichier sty pour LaTeX)
  * xstring.tex (le package lui même)
  * xstring_doc_en.tex and xstring_doc_en.pdf (manuel en anglais)
  * xstring_doc_fr.tex and xstring_doc_fr.pdf (manuel en français)
  * test_etex.tex and test_etex.pdf (fichier test à compiler avec etex)
  * test_latex.tex and test_latex.pdf (fichier test à compiler avec LaTeX)
  * README (ce fichier)

                                                      Christian Tellechea
                                                     <unbonpetit@gmail.com>