resme 0.2.0 → 0.3.0

data/lib/resme/templates/resume.yml

@@ -1,13 +1,14 @@
 # Basic template for a resume to be processed by RESME (rubygems.org/gems/resme)
 #
-# The standard templates support dates written in one of the following formats:
+# The standard output templates support dates written in one of the
+# following formats:
 #
 # - a ruby date (e.g., YYYY-MM-DD)
-# - YYYY-MM
-# - YYYY
+# - a month: YYYY-MM
+# - a year: YYYY
 #
 # Notice that you can add your own keywords, if you want (but you need to modify
-# the ERB templates to actually output them).
+# the ERB templates to actually output your custom fields)
 
 ---
 
@@ -16,6 +17,7 @@
 # marital_status is currently not used
 basics:
   first_name:
+  middle_name:
   last_name:
   title:
   picture:
@@ -26,7 +28,7 @@ basics:
 
 # how to get in contact with you
 # one or more entries: each entry has a label and value.
-# you can use it for email, whatsup, mobile, ...
+# you can use it for email, mobile, whats app, ...
 # mobile and email are two good starting points
 contacts:
   - label:
@@ -45,14 +47,15 @@ addresses:
 
 # this is your presence on the net
 # one or more entries: each entry has a label and value.
-# you can use it for, e.g., twitter, facebook, github, telegram, ...
+# you can use it for, e.g., Twitter, Facebook, Github, ...
 web_presence:
-  - label: 
-    value: 
+  - label:
+    value:
 
 # what you are looking for and/or a summary of who you are
-# if multiline entry don't forget to use ">-" or "|-" (see
-# the YML documentation for more information)
+#
+# if you write a multi-line entry don't forget to use ">-" or "|-"
+# (see the YAML documentation for more information)
 summary: 
 
 #
@@ -78,8 +81,8 @@ work:
 # teaching experience
 teaching:
   - who:
-    address:
     school:
+    address:
     role:
     subject:
     till:
@@ -89,7 +92,7 @@ teaching:
 
 # the projects you have worked on
 projects:
-  - name: 
+  - name:
     size:
     who:
     role:
@@ -112,15 +115,15 @@ committees:
     editions:
     url:
 
-# work as volunteer 
+# work as volunteer
 volunteer:
   - who:
-    till: 
+    till:
     from:
     role:
     summary:
 
-# mobility programs and other similar initiatives (e.g., erasmus grants)
+# mobility programs and other similar initiatives (e.g., Erasmus grants)
 visits:
   - who:
     address:
@@ -138,14 +141,14 @@ education:
     address:
     till:
     from:
-    publish:
+    publish: yes
 
 # publications
 publications:
   - title:
     authors:
     publisher:
-    date: 
+    date:
     url:
 
 # invited talks
@@ -153,32 +156,33 @@ talks:
   - title:
     venue:
     date:
+    url:
 
 # any award
 awards:
-  - title:
-    who:
-    where:
+  - who:
+    address:
     date:
+    title:
     summary:
     
 # any interesting achievement you want to highlight?
 achievements:
-  - title:
-    who:
-    where:
+  - who:
+    address:
     date:
+    title:
     summary:
 
 # did you develop (or participate to the development) of any software
 # system you want to publicize in your resume?
 software:
-   - title:
-     url:
-     role:
-     language:
-     license:
-     summary:
+  - title:
+    url:
+    programming_language:
+    license:
+    role:
+    summary:
 
 # what are your skills?
 skills:
@@ -189,22 +193,22 @@ skills:
 # linguistic competences
 # if it is irrelevant for the job, delete this section
 #
-# the structure is strongly inspired by the EUROPASS standard:
+# the structure is strongly inspired by the Europass standard:
 # first the list of mother tongues and then all the other languages
-# you have some profiency with.
+# you have some proficiency with.
 #
 # For the proficiency level, you can use the "level" keyword, whose
 # value is a string (e.g., "EXCELLENT", "INTERMEDIATE").  The level is
-# outputted in the markdown and json templates.
+# outputted in the markdown and JSON templates.
 #
 # The Europass format requires to specify more information, that is,
-# your proficiency in five different areas.  Profiency is from A1 to
+# your proficiency in five different areas.  Proficiency is from A1 to
 # C2; the areas include understanding, speaking, writing. See the
 # documentation of the Europass format for more details.
 
 languages:
   mother_tongues:
-    - code: 
+    - code:
       language:
 
   foreign:
@@ -221,7 +225,7 @@ languages:
 # (this also comes from the Europass standard)
 # if it is irrelevant for the job, delete this section
 driving:
-  - license: 
+  - license:
 
 # do you have any interests?
 # if it is irrelevant for the job, delete this section
@@ -229,12 +233,12 @@ interests:
   - name:
     level:
     summary:
-  
+
 # do you have any references?
 # if it is irrelevant for the job, delete this section
 references:
   - name:
-    contact:
+    contacts:
+      - label:
+        value:
     reference:
-
-    

data/lib/resme/templates/schema.yml

@@ -0,0 +1,494 @@
+type:      map
+mapping:
+  "basics":
+    type:      map
+    required:  yes
+    mapping:
+      "first_name":
+        type: str
+        required: yes
+      "middle_name":
+        type: str
+        required: no
+      "last_name":
+        type: str
+        required: yes
+      "title":
+        type: str
+        required: no
+      "picture":
+        type: str
+        required: no
+      "birthdate":
+        type: date
+        required: no
+      "nationality":
+        type: str
+        required: no
+      "marital_status":
+        type: str
+        required: no
+      "gender":
+        type: str
+        required: no
+  "contacts":
+    type: seq
+    required: yes
+    sequence:
+      - type: map
+        mapping:
+          "label":
+            type: str
+            required: yes
+          "value":
+            type: str
+            required: yes
+  "addresses":
+    type: seq
+    required: yes
+    sequence:
+      - type: map
+        mapping:
+          "label":
+            type: str
+            required: yes
+          "street":
+            type: str
+            required: no
+          "zip_code":
+            type: scalar
+            required: no
+          "city":
+            type: str
+            required: no
+          "country":
+            type: str
+            required: no
+  "web_presence":
+    type: seq
+    required: no
+    sequence:
+      - type: map
+        mapping:
+          "label":
+            type: str
+            required: yes
+          "value":
+            type: str
+            required: yes
+  "summary":
+    type: str
+    required: no
+  "work":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "who":
+            type:      str
+            required:  yes
+         "website":
+            type:      str
+            required:  no
+         "address":
+            type:      str
+            required:  no
+         "till":
+            type:      scalar
+            required:  no
+         "from":
+            type:      scalar
+            required:  yes
+         "role":
+            type:      str
+            required:  yes
+         "summary":
+            type:      str
+            required:  yes
+         "details":
+            type:      str
+            required:  no
+  "teaching":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "who":
+            type:      str
+            required:  yes
+         "school":
+            type:      str
+            required:  no
+         "address":
+            type:      str
+            required:  no
+         "till":
+            type:      scalar
+            required:  no
+         "from":
+            type:      scalar
+            required:  yes
+         "role":
+            type:      str
+            required:  yes
+         "subject":
+            type:      str
+            required:  yes
+         "summary":
+            type:      str
+            required:  no
+         "details":
+            type:      str
+            required:  no
+  "projects":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "name":
+            type:      str
+            required:  yes
+         "size":
+            type:      str
+            required:  no
+         "who":
+            type:      str
+            required:  no
+         "till":
+            type:      scalar
+            required:  no
+         "from":
+            type:      scalar
+            required:  yes
+         "role":
+            type:      str
+            required:  yes
+         "summary":
+            type:      str
+            required:  no
+  "other":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "who":
+            type:      str
+            required:  yes
+         "till":
+            type:      scalar
+            required:  no
+         "from":
+            type:      scalar
+            required:  yes
+         "role":
+            type:      str
+            required:  yes
+         "summary":
+            type:      str
+            required:  no
+  "committees":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "who":
+            type:      str
+            required:  yes
+         "role":
+            type:      str
+            required:  yes
+         "editions":
+            type:      scalar
+            required:  no
+         "url":
+            type:      str
+            required:  no
+  "volunteer":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "who":
+            type:      str
+            required:  yes
+         "where":
+            type:      str
+            required:  no
+         "date":
+            type:      scalar
+            required:  no
+         "till":
+            type:      scalar
+            required:  no
+         "from":
+            type:      scalar
+            required:  no
+         "role":
+            type:      str
+            required:  yes
+         "summary":
+            type:      str
+            required:  no
+  "visits":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "who":
+            type:      str
+            required:  yes
+         "address":
+            type:      str
+            required:  no
+         "till":
+            type:      scalar
+            required:  yes
+         "from":
+            type:      scalar
+            required:  yes
+         "role":
+            type:      str
+            required:  yes
+         "summary":
+            type:      str
+            required:  no
+  "education":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "degree":
+            type:      str
+            required:  no
+         "topic":
+            type:      str
+            required:  no
+         "school":
+            type:      str
+            required:  yes
+         "address":
+            type:      str
+            required:  no
+         "date":
+            type:      scalar
+            required:  no
+         "till":
+            type:      scalar
+            required:  no
+         "from":
+            type:      scalar
+            required:  no
+         "publish":
+            type:      bool
+            required:  yes
+         "score":
+            type:      scalar
+            required:  no
+  "publications":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "title":
+            type:      str
+            required:  yes
+         "authors":
+            type:      str
+            required:  yes
+         "publisher":
+            type:      str
+            required:  yes
+         "date":
+            type:      scalar
+            required:  yes
+         "url":
+            type:      str
+            required:  no
+  "talks":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "title":
+            type:      str
+            required:  yes
+         "venue":
+            type:      str
+            required:  yes
+         "date":
+            type:      scalar
+            required:  yes
+         "url":
+            type:      str
+            required:  no
+  "awards":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "who":
+            type:      str
+            required:  yes
+         "address":
+            type:      str
+            required:  no
+         "date":
+            type:      scalar
+            required:  yes
+         "title":
+            type:      str
+            required:  yes
+         "summary":
+            type:      str
+            required:  no
+  "achievements":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "who":
+            type:      str
+            required:  yes
+         "address":
+            type:      str
+            required:  no
+         "date":
+            type:      scalar
+            required:  no
+         "title":
+            type:      str
+            required:  yes
+         "summary":
+            type:      str
+            required:  no
+  "software":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "title":
+            type:      str
+            required:  yes
+         "url":
+            type:      str
+            required:  no
+         "programming_language":
+            type:      str
+            required:  no
+         "license":
+            type:      str
+            required:  no
+         "role":
+            type:      str
+            required:  no
+         "summary":
+            type:      str
+            required:  no
+  "skills":
+    type: seq
+    required: no
+    sequence:
+      - type: map
+        mapping:
+          "name":
+            type: str
+            required: yes
+          "level":
+            type: str
+            required: no
+          "summary":
+            type: str
+            required: no
+  "driving":
+    type: seq
+    required: no
+    sequence:
+      - type: map
+        mapping:
+          "license":
+            type: str
+            required: yes
+  "languages":
+    type: map
+    mapping:
+      "mother_tongues":
+        type: seq
+        required: yes
+        sequence:
+          - type: map
+            mapping:
+              "code":
+                type: str
+                required: no
+              "language":
+                type: str
+                required: yes
+      "foreign":
+        type: seq
+        required: no
+        sequence:
+          - type: map
+            mapping:
+              "code":
+                type: str
+                required: no
+              "language":
+                type: str
+                required: yes
+              "level":
+                type: str
+                required: no
+              "listening":
+                type: str
+                required: no
+              "reading":
+                type: str
+                required: no
+              "spoken_interaction":
+                type: str
+                required: no
+              "spoken_production":
+                type: str
+                required: no
+              "writing":
+                type: str
+                required: no
+  "interests":
+    type: seq
+    required: no
+    sequence:
+      - type: map
+        mapping:
+          "name":
+            type: str
+            required: yes
+          "level":
+            type: str
+            required: no
+          "summary":
+            type: str
+            required: no
+  "references":
+    type: seq
+    required: no
+    sequence:
+      - type: map
+        mapping:
+          "name":
+            type: str
+            required: yes
+          "reference":
+            type: str
+            required: yes
+          "contacts":
+            type: seq
+            required: no
+            sequence:
+              - type: map
+                mapping:
+                  "label":
+                    type: str
+                    required: yes
+                  "value":
+                    type: str
+                    required: yes