xmlresume2x 0.2.0

data/data/xmlresume2x/lang/en.cfg

@@ -0,0 +1,72 @@
+# Configuration for the resume converter -*- ruby -*-
+# Language file
+
+keyword(
+        # general keywords
+        :Resume => 'Résumé',
+        :Of => 'of',
+        :In => 'in',
+        :And => 'and',
+        :AdditionalInformation => 'Additional Information',
+        :Phone => 'Phone',
+        :Phone_Home => 'Home Phone',
+        :Phone_Work => 'Work Phone',
+        :Phone_Mobile => 'Mobile Phone',
+        :Fax => 'Fax',
+        :Fax_Home => 'Home Fax',
+        :Fax_Work => 'Work Fax',
+        :Pager => 'Pager',
+        :IM_Aim => 'AIM',
+        :IM_Icq => 'ICQ',
+        :IM_Irc => 'IRC',
+        :IM_Jabber => 'Jabber',
+        :IM_Msn => 'MSN Messenger',
+        :IM_Yahoo => 'Yahoo! Messenger',
+        :Email => 'Email',
+        :Url => 'URL',
+        :Projects => 'Projects',
+        :Dates => 'Dates',
+        :LastModified => 'Last modified',
+        :Present => 'Present',
+
+        # for job history
+        :History_Title => 'Work Experience',
+        :History_Employer => 'Name and address of employer',
+        :History_Occupation => 'Occupation or position held',
+        :History_MainActivities => 'Main activities and responsibilities',
+        :History_Achievements => 'Achievements',
+
+        # for education
+        :Education_Title => 'Education And Training',
+        :Education_Organization => 'Name and type of organization providing education and training',
+        :Education_Level => 'Title of qualification awarded',
+        :Education_MajorStudies => 'Major Studies',
+        :Education_MinorStudies => 'Minor Studies',
+        :Education_Minor => 'minor',
+        :Education_Minors => 'minors',
+        :Education_Gpa => 'Grade Point Average (GPA)',
+        :Education_Gpa_Overall => 'Overall',
+        :Education_Gpa_Major => 'Major',
+        :Education_Gpa_Outof => 'out of',
+        :Education_Subjects => 'Subjects',
+
+        # for skills
+        :Skills_Title => 'Skills',
+
+        # for publications
+        :Publications_Title => 'Publications',
+        :Publications_In => 'in',
+
+        # for interests
+        :Interests_Title => 'Interests',
+
+        # for security clearances
+        :SecurityClearances_Title => 'Security Clearances',
+
+        # for awards
+        :Awards_Title => 'Awards',
+
+        # for referees
+        :Referees_Title => 'References'
+
+        )

data/data/xmlresume2x/lang/fr.cfg

@@ -0,0 +1,73 @@
+# Configuration for the resume converter -*- ruby -*-
+# Language file
+# Thanks to Eva Langthaler for helping me with the translations
+
+keyword(
+        # general keywords
+        :Resume => 'Curriculum Vitae',
+        :Of => 'de',
+        :In => 'en',
+        :And => 'et',
+        :AdditionalInformation => 'Informations Supplémentaires',
+        :Phone => 'Téléphone',
+        :Phone_Home => 'Téléphone privé',
+        :Phone_Work => 'Téléphone au travail',
+        :Phone_Mobile => 'Téléphone GSM',
+        :Fax => 'Télécopie',
+        :Fax_Home => 'Télécopie privé',
+        :Fax_Work => 'Télécopie au travail',
+        :Pager => 'Pager',
+        :IM_Aim => 'AIM',
+        :IM_Icq => 'ICQ',
+        :IM_Irc => 'IRC',
+        :IM_Jabber => 'Jabber',
+        :IM_Msn => 'MSN Messenger',
+        :IM_Yahoo => 'Yahoo! Messenger',
+        :Email => 'Courrier électronique',
+        :Url => 'URL',
+        :Projects => 'Projets',
+        :Dates => 'Dates',
+        :LastModified => 'Dernier modification',
+        :Present => 'Présent',
+
+        # for job history
+        :History_Title => 'Expérience Professionnelle',
+        :History_Employer => 'Nom et adresse de l''employeur',
+        :History_Occupation => 'Fonction ou poste occupé',
+        :History_MainActivities => 'Principales activités et responsabilités',
+        :History_Achievements => 'Réalisations',
+
+        # for education
+        :Education_Title => 'Education et Formation',
+        :Education_Organization => 'Nom et type de l''établissement disposant l''enseignement ou la formation',
+        :Education_Level => 'Intitulé du certificat ou diplôme délivré',
+        :Education_MajorStudies => 'Matières principales',
+        :Education_MinorStudies => 'Matières secondaires',
+        :Education_Minor => 'Matière secondaire',
+        :Education_Minors => 'Matières secondaires',
+        :Education_Gpa => 'Terme moyen des notes',
+        :Education_Gpa_Overall => 'Terme moyen des toutes les notes',
+        :Education_Gpa_Major => 'Terme moyen des notes des matières principales',
+        :Education_Gpa_Outof => 'de',
+        :Education_Subjects => 'Matières',
+
+        # for skills
+        :Skills_Title => 'Capacité',
+
+        # for publications
+        :Publications_Title => 'Publications',
+        :Publications_In => 'Dans',
+
+        # for interests
+        :Interests_Title => 'Intérêts',
+
+        # for security clearances
+        :SecurityClearances_Title => 'Compétence de sécurité',
+
+        # for awards
+        :Awards_Title => 'Distinctions',
+
+        # for referees
+        :Referees_Title => 'Références'
+
+        )

data/doc/src/default.css

@@ -0,0 +1,137 @@
+  html {
+	margin: 0px 5%;
+	background-color: #eee;
+  }
+
+  body {
+	margin: 0px;
+	padding: 0px;
+	background-color: #fff;
+	font-size: 12px;
+	font-family: Verdana, Arial, Helvetica;
+  }
+
+  /* General layout of the page */
+
+  #header, #footer {
+	width: 100%;
+	background-color: #58b;
+	color: #fff;
+  }
+
+  #menu {
+	float: left;
+	width: 230px;
+    padding: 20px 0px 0px 20px;
+	border: 3px solid #58b;
+  }
+
+  #body {
+	margin-left: 250px;
+	padding: 20px;
+  }
+
+  #footer {
+	clear: both;
+	padding: 5px 0px;
+	text-align: center;
+  }
+
+
+  /* styling the header */
+
+  #headerbar {
+	width: 100%;
+	font-size: 90%;
+  }
+
+  span#navbar, span#languages {
+	padding: 3px;
+	width: 45%;
+  }
+
+  span#navbar {
+	float: left;
+	text-align: left;
+  }
+
+  span#languages {
+	float: right;
+	text-align: right;
+  }
+
+  div#header h1, h2 {
+	margin: 0px;
+	padding: 15px 50px 0px;
+
+    font-size: 300%;
+	font-style: italic;
+	font-weight: normal;
+  }
+
+  div#header h2 {
+    padding-top: 0px;
+    padding-bottom: 15px;
+    font-size: 100%;
+  }
+
+  /* styling the menu */
+
+  #menu a {
+	text-decoration: none;
+	color: #b55;
+	font-weight: bold;
+	font-size: 130%;
+  }
+
+  #menu a:hover {
+	text-decoration: underline;
+  }
+
+  #menu .webgen-menuitem-selected {
+	border-left: 3px solid #58b;
+  }
+
+  #menu .webgen-submenu {
+  }
+
+  #menu ul {
+	list-style-type: none;
+	padding: 0px;
+	margin-left: 10px;
+  }
+
+  #menu li > ul {
+	font-size: 95%;
+  }
+
+  #menu li {
+    margin: 0.0em 0px;
+    padding: 2px 0px;
+    padding-left: 5px;
+    border-left: 3px solid #CCCCCC;
+  }
+
+  /* styling the content */
+
+  div.section {
+	margin-bottom: 30px;
+  }
+
+  h2.section_header {
+	padding: 0px;
+	border-bottom: 3px double #8b5;
+
+	letter-spacing: 0.2em;
+	font-size: 150%;
+	font-weight: bold;
+	color: #8b5;
+  }
+
+  pre.webgen-file {
+    padding-left: 10px;
+    margin: 0px 10px;
+    border-left: 3px solid #8b5;
+  }
+
+}

data/doc/src/default.template

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>XMLResume2x: {title: }</title>
+    <link href="{relocatable: default.css}" rel="stylesheet" />
+  </head>
+  <body>
+    <div id="header">
+      <h1>{title: }</h1>
+      <h2>xmlresume2x: converts an xml resume to various output formats</h2>
+      <div id="headerbar">
+        <span id="navbar">{navbar: }</span>
+        <span id="languages">{lang: }</span>
+        <div style="clear: both; border-top: 1px solid #58b"></div>
+      </div>
+    </div>
+
+    <div id="menu">
+      {menu: }
+    </div>
+
+    <div id="body">
+      {content: }
+    </div>
+
+    <div id="footer">
+        generated with <em><b><a href="http://webgen.rubyforge.org">webgen</a></b></em> on <b>{date: }</b>
+    </div>
+
+  </body>
+</html>

data/doc/src/download.fragment

@@ -0,0 +1,40 @@
+<div class="section">
+<h2 class="section_header">Download</h2>
+<p>The newest version of xmlresume2x can be downloaded from Rubyforge.</p>
+<p>Homepage: <a href="http://xmlresume2x.rubyforge.org">xmlresume2x.rubyforge.org</a><br />
+Download: <a href="http://rubyforge.org/frs/?group_id=459">http://rubyforge.org/frs/?group_id=459</a>
+</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">Dependencies</h2>
+<p>None</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">Installation</h2>
+
+You can use the standard way to install xmlresume2x. Download the package, open up a terminal and
+change into the package root. Then do the following:
+<pre>
+ $ ruby setup.rb config
+ $ ruby setup.rb setup
+ $ ruby setup.rb install
+</pre>
+
+Or you could use Rake and substitute the above commands with this:
+<pre>
+ $ rake install
+</pre>
+
+Or you could use the RPA way:
+<pre>
+ $ rpa install xmlresume2x
+</pre>
+
+Or you could use the GEM way:
+<pre>
+ $ gem install xmlresume2x
+</pre>
+
+</div>

data/doc/src/examples.fragment

@@ -0,0 +1,24 @@
+<div class="section">
+<h2 class="section_header">Example files</h2>
+<p>Here are the results when xmlresume2x is used for converting the two example résumés provided by
+xmlresume.sf.net</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">Example1</h2>
+<ul>
+  <li><a href="examples/example1.xml">XML source</a></li>
+  <li><a href="examples/example1.pdf">PDF version</a></li>
+  <li><a href="examples/example1.html">HTML version (without stylesheet)</a></li>
+</ul>
+</div>
+
+<div class="section">
+<h2 class="section_header">Example2</h2>
+<ul>
+  <li><a href="examples/example2.xml">XML source</a></li>
+  <li><a href="examples/example2.pdf">PDF version</a></li>
+  <li><a href="examples/example2.html">HTML version (without stylesheet)</a></li>
+</ul>
+
+</div>

data/doc/src/features.fragment

@@ -0,0 +1,9 @@
+<div class="section">
+<h2 class="section_header">Feature list</h2>
+<ul>
+  <li>Uses the XML standard for résumés provided by <a href="http://xmlresume.sf.net">xmlresume.sf.net</a></li>
+  <li>Configuration files are pure Ruby - unleash the power!</li>
+  <li>Publish your résumé in PDF (using a good looking LaTeX template) or HTML!</li>
+  <li>Easily extendable</li>
+</ul>
+</div>

data/doc/src/index.fragment

@@ -0,0 +1,29 @@
+<div class="section">
+<h2 class="section_header">Welcome</h2>
+<p>... to the homepage of <i><b>xmlresume2x</b></i>, a converter for xml resumes.</p>
+<p>Have a look around the site!</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">Description</h2>
+<p>The <a href="http://xmlresume.sourceforge.net">"XML Résumé Library"</a> provides a way for storing
+one's résumé data in a consistent way. The XML résumé can be transformed to various output formats,
+including text, HTML and PDF by utilizing XSLT.</p>
+
+<p>I came across the <a href="http://www.cedefop.eu.int/transparency/cv.asp">European Curriculum
+Vitae</a> format which provides a standard for CVs in Europe. Nicola Vitacolonna has used this
+information to provide a LaTeX class - <a
+href="http://www.ctan.org/tex-archive/help/Catalogue/entries/europecv.html">europecv</a> - which
+(nearly) conforms to this standard. As the XML Résumé Library does not have a converter for this, I
+wrote this program to convert an XML résumé to a LaTeX file which uses the europecv class.</p>
+
+<p>During the development process I realized that it would be useful to add support for other output
+formats. Therefore I changed the conversion process to use configuration files so that this program
+can be used to transform a résumé to any output format.</p>
+
+</div>
+
+<div class="section">
+<h2 class="section_header">And so ...</h2>
+<p>... have fun!</p>
+</div>

data/doc/src/manual.fragment

@@ -0,0 +1,135 @@
+<p align="center" style="font-size: Large; font-weight: bold">This manual is for version {includeFile: ../../VERSION} of xmlresume2x!</p>
+
+<div class="section">
+<h2 class="section_header">How To Use xmlresume2x?</h2>
+<p>xmlresume2x is a CLI application, ie. you can only use it from the command line. You need to
+specify the XML resume file which you want to convert, the output format and the language, like this:</p>
+<pre>
+xmlresume2x -f latex-europecv -l en myresume.xml
+</pre>
+<p>The former converts the resume <code>myresume.xml</code> into a LaTeX file which uses the
+latex-europecv class. Have a look at the help screen for other available options.</p>
+
+<p>If you are not satisfied with the way some things are transformed or named, you can specify your
+own configuration file. This allows you to override the default transformation settings.</p>
+<p>The resume files have to conform to XML resume >=1.5.1, must not use deprecated elements and have
+to use the element <code>&lt;resume&gt;</code> as root element!</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">How It Works</h2>
+<p>The application itself is rather simple, the power lies in the configuration files. There are two
+types of configuration files, for formats and for languages. A format file is the equivalent to an
+XSL file: it defines how the XML file is translated. A language file contains phrases in a specific
+language which are then used in the format files.</p>
+
+<p>When xmlresume2x is started, the given format and language files are read and the input file is
+translated accordingly.</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">Currently Available Formats And Languages</h2>
+<dl>
+  <dt>Formats</dt>
+  <dd>latex-europecv (for producing PDF and other formats supported by LaTeX), xhtml</dd>
+
+  <dt>Languages</dt>
+  <dd>English (en), German (de), French (fr)</dd>
+</dl>
+</div>
+
+
+<div class="section">
+<h2 class="section_header">Configuration Files</h2>
+<p>The configuration files are pure Ruby files, so you can use the full power of Ruby!</p>
+
+<p>Basically, all you do in a configuration file is:</p>
+<ol>
+  <li>Define processors for specific XML elements</li>
+  <li>Define keywords for a specific language</li>
+</ol>
+<p>Normally, these two actions are separated from each other and put into different files: one or
+more format files and one or more language files. This separation does not have to occur, as
+processors and keywords can be defined in any configuration file. However, this separation makes it
+easier to combine languages and formats.</p>
+
+<p>The configuration files are normally located in the <code>/usr/share/xmlresume2x</code>
+directory. Format files should go into the sub directory <code>format</code> and language files in
+the sub directory <code>lang</code>.</p>
+
+
+<h3>List of available commands</h3>
+<p>This is a list of additional commands that can and should be used in configuration files (<a
+href="rdoc/classes/XMLResume2x/ResumeProcessor.html">here</a> is a description of them):</p>
+<ul>
+  <li>add_processor</li>
+  <li>processor</li>
+  <li>call_processor</li>
+  <li>keyword</li>
+  <li>get_value</li>
+  <li>get_children_value</li>
+  <li>load_config</li>
+</ul>
+
+<h3>Processors</h3>
+
+<p>Processors are the heart of the transformation process. You can create an unlimited number of
+processors which can be assigned to specific XML elements. Each processor defines how an XML element
+should be transformed (the XSL equivalent would be <code>xsl:template</code>). Let's take a look at
+an example:</p>
+<pre>
+processor 'contact' => 'ContactProcessor' do |contact|
+  str = ''
+  str &lt;&lt; contact.phone.collect {|phone| "#{phone_location(phone._location)}: #{phone}" }.join( NEWLINE ) if contact.phone
+  str &lt;&lt; NEWLINE + contact.fax.collect {|fax| "#{fax_location(fax._location)}: #{fax}" }.join( NEWLINE ) if contact.fax
+  str &lt;&lt; NEWLINE + contact.pager.collect {|pager| "#{keyword(:Pager)}: #{pager}" }.join( NEWLINE ) if contact.pager
+  str &lt;&lt; NEWLINE + contact.email.collect {|email| "#{keyword(:Email)}: \\url{#{email}}" }.join( NEWLINE ) if contact.email
+  str &lt;&lt; NEWLINE + contact.url.collect {|url| "#{keyword(:Url)}: \\url{#{url}}" }.join( NEWLINE ) if contact.url
+  str &lt;&lt; NEWLINE + contact.instantMessage.collect {|im| "#{im_service(im._service)}: #{im}" }.join( NEWLINE ) if contact.instantMessage
+  str
+end
+</pre>
+<p>This defines a processor <code>ContactProcessor</code> which is assigned to the element
+<code>contact</code>. All the format files shipped with xmlresume2x use a convention for the
+processor names: <code>&lt;capitalized element name&gt;Processor</code> (useful when overriding a
+processor with a user defined one). The first parameter is always the element which should be
+transformed (there is an optional second parameter for passing options). The associated block
+defines how the <code>contact</code> is transformed.</p>
+
+<p>REXML is used for reading in the XML resume. Two wrapper classes are used to simplify the use of
+the XML elements: ElementWrapper wraps a single REXML::Element objecct and ElementWrapperList wraps
+a bunch of them. Using these wrappers, you can do the following:</p>
+<ul>
+  <li>Access the first <code>phone</code> subelement from contact: <code>contact.phone</code></li>
+  <li>Join all phones: <code>contact.phone.join(', ')</code></li>
+  <li>Access the attribute <code>location</code> of the first <code>phone</code> subelement: <code>contact.phone._location</code></li>
+</ul>
+
+<p>So, subelements of an element are accessed by using the name of the subelement as method name. If
+there is more than one subelement of the same type, you can use the bracket notation to access the
+others: <code>contact.phone[1]</code>. Attributes of an element are accessed by prepending an
+underscore to the attribute name and using that as method name.</p>
+
+<h3>Keywords</h3>
+
+<p>Not all words in the result document are directly taken from the XML resume file. Some words,
+e.g. headers like <code>Additional Information</code>, are inserted to make reading easier.
+Naturally, these words are not the same in every language and therefore they have to be defined
+somewhere.</p>
+
+<p>These keywords are normally defined in the language files. These files are Ruby source files too
+and contain statements like this:</p>
+<pre>
+keyword(
+        # general keywords
+        :Resume => 'Resume',
+        :Of => 'of',
+        :AdditionalInformation => 'Additional Information',
+       )
+</pre>
+<p>The <code>keyword</code> function takes a Hash as argument to define new keywords or overwrite
+already defined ones. The key has to be a Symbol and the value has to be a String in UTF8 format. Any
+keyword can be defined this way and later, in a configuration file, used by calling the
+<code>keyword</code> function with a Symbol as argument.</p>
+
+</div>