-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
349 lines (293 loc) · 10.8 KB
/
README
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
=================================================================================
* README *
=================================================================================
* Project : CV-XML
* Creation Date : 2008/02/10
* Last update : 2008/02/11
* Website : http://adrien.frenchcomp.net
* Authors : Adrien MOGENET <[email protected]>
---------------------------------------------------------------------------------
I) TABLE OF CONTENT
---------------------------------------------------------------------------------
1) What is CV-XML ?
2) How to install it ?
a) Requirements
b) Configuration
c) Test it !
3) How to use it ?
a) The program
b) The input format
c) HTML format
4) How create/edit themes ?
5) FAQ
---------------------------------------------------------------------------------
II) CONTENT
---------------------------------------------------------------------------------
1) What is CV-XML ?
-------------------
You hate writing / editing / updating / managing your resume(s) in
several formats ? CV-XML is going to make your life easier !
Just fill a XML file, with a simple text editor, then launch CV-XML,
and enjoy the result !
CV-XML generate beautiful resumes in PDF, HTML, LaTeX or others formats.
2) How to install it ?
----------------------
a) Requirements
---------------
To use CV-XML, you need several packages :
* a shell
which is able to execute shell scripts.
* unix tools :
cut, rev and basename are the 3 used tools.
* xsltproc
Program to generate HTML and LaTeX files.
* fop
Program to generate PDF, PS and TXT files. If you don't
have it, you can download fop here :
-> http://xmlgraphics.apache.org/fop/download.html
b) Configuration
----------------
To install CV-XML, first decompress the tarball (gzip format) :
user@host: tar xzf cvxml-1.0.tar.gz
Then, edit the file "cv-xml". You can edit the first block. The most
important part is the second part, called "Path to needed
binaries".
Default values may work, but you can edit it.
c) Test it !
------------
Want to test quickly this program ? No problem ! There is a
sample called 'example.xml' in the 'your-cv' directory.
Just launch CV-XML like that :
user@host: ./cv-xml -pdf -html-tex -txt
Then admire the result, opening the different files created in
the 'output' directory.
3) How to use it ?
------------------
a) The program
--------------
Very easy ! Launch the script :
user@host: ./cv-xml [Options] [file1.xml file2.xml ...]
Available options :
* -pdf : Generate a pdf file
* -html : Generate a html file
* -txt : Generate a txt file
* -tex : Generate a LaTeX file
* -theme "mytheme" : Select the theme "mytheme"
b) Input format
---------------
The input file is a XML file, with structure described with the
dtd in the file your-cv/cv.dtd.
Here is a a description of the different possible
markups.
Mandatory fields are marked with a "*"
Optional fields are marked with a "-"
#-------------------------------------------------------------------------
| <resume>
#-------------------------------------------------------------------------
|
| Description : Root nodes
|
| Parent : None
|
| Attributes : - language
| - author
| - version
| - date
|
| Childs : * header
| * body
|
|
#-------------------------------------------------------------------------
| <header>
#-------------------------------------------------------------------------
|
| Parent : <resume>
|
| Description :
|
| Childs : * name
| * lastname
|
#-------------------------------------------------------------------------
| <name>
#-------------------------------------------------------------------------
|
| Parent : <header>
|
#-------------------------------------------------------------------------
| <lastname>
#-------------------------------------------------------------------------
|
| Parent : <header>
|
#-------------------------------------------------------------------------
| <age>
#-------------------------------------------------------------------------
|
| Parent : <header>
|
#-------------------------------------------------------------------------
| <nationality>
#-------------------------------------------------------------------------
|
| Parent : <header>
|
#-------------------------------------------------------------------------
| <title>
#-------------------------------------------------------------------------
|
| Parent : <header>
|
#-------------------------------------------------------------------------
| <objective>
#-------------------------------------------------------------------------
|
| Parent : <header>
|
#-------------------------------------------------------------------------
| <coords>
#-------------------------------------------------------------------------
|
| Parent : <header>
|
#-------------------------------------------------------------------------
| <address>
#-------------------------------------------------------------------------
|
| Parent : <coords>
|
#-------------------------------------------------------------------------
| <phone>
#-------------------------------------------------------------------------
|
| Parent : <coords>
|
#-------------------------------------------------------------------------
| <email>
#-------------------------------------------------------------------------
|
| Parent : <coords>
|
#-------------------------------------------------------------------------
| <body>
#-------------------------------------------------------------------------
|
| Parent : <resume>
|
#-------------------------------------------------------------------------
| <section>
#-------------------------------------------------------------------------
|
| Parent : <body>
|
#-------------------------------------------------------------------------
| <title>
#-------------------------------------------------------------------------
|
| Parent : <section>
|
#-------------------------------------------------------------------------
| <description>
#-------------------------------------------------------------------------
|
| Parent : <section>
|
#-------------------------------------------------------------------------
| <details>
#-------------------------------------------------------------------------
|
| Parent : <section>
|
#-------------------------------------------------------------------------
| <element>
#-------------------------------------------------------------------------
|
| Parent : <details>
|
#-------------------------------------------------------------------------
| <label>
#-------------------------------------------------------------------------
|
| Parent : <element>
|
#-------------------------------------------------------------------------
| <location>
#-------------------------------------------------------------------------
|
| Parent : <element>
|
#-------------------------------------------------------------------------
| <left>
#-------------------------------------------------------------------------
|
| Parent : <element>
|
#-------------------------------------------------------------------------
| <date>
#-------------------------------------------------------------------------
|
| Parent : <element>
|
#-------------------------------------------------------------------------
| <duration>
#-------------------------------------------------------------------------
|
| Parent : <element>
|
#-------------------------------------------------------------------------
| <description>
#-------------------------------------------------------------------------
|
| Parent : <element>
|
#-------------------------------------------------------------------------
| <apport>
#-------------------------------------------------------------------------
|
| Parent : <element>
|
#-------------------------------------------------------------------------
| <placename>
#-------------------------------------------------------------------------
|
| Parent : <location>
|
#-------------------------------------------------------------------------
| <country>
#-------------------------------------------------------------------------
|
| Parent : <location>
|
#-------------------------------------------------------------------------
| <town>
#-------------------------------------------------------------------------
|
| Parent : <location>
|
#-------------------------------------------------------------------------
c) HTML format
--------------
HTML files are encoded in UTF-8. That's why text with accents or
special characters may be curiously printed if the browser print
these characters in another charset, for any reason.
To solve this problem, put a ".htaccess" file in your resumes's
directory with the following line :
AddDefaultCharset UTF-8
4) How to edit/create a theme ?
-------------------------------
All the themes are stored in the ./themes folder. Each theme
directory contains different files :
* pdf.xsl : XSL-Fo stylesheet
* html.xsl : XSL stylesheet
* style.css : Linked CSS file for the HTML output
* latex.xsl : XSL stylesheet
* txt.xsl : XSL-Fo stylesheet
5) Frequently Asked Questions
-----------------------------
1) Why do I have to repeat sometimes the "type of the field"
(ie: <nationality>Nationality: French</nationality>
- It's the best way I found to keep the content easy to
translate in the different cases.
================================================================================
Adrien MOGENET