Member maps - fix, document

- modified the script to better handle the frontmatter
- generated new member-locations.js (with the above script)
- Modified the readme (add conventions, link to wiki)

Author: fmeyenhofer

Gemfile.lock

@@ -2,20 +2,20 @@
 Website for the SwissBIAS network: Swiss BioImage Analysts' network
 See also the associated [wiki](https://github.com/SwissBIAS/SwissBIAS.github.io/wiki)
 
-
 ## How to contribute
 We decided to keep some control over what’s published by merging Pull Requests. So ***please fork, modify, PR*** and then we’ll merge your changes. Please see this [guide to create a Pull Request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). \
-If you would prefer to generate a dummy website to make sure it looks exactly as you want before pushing it, you can create your locally served website. To do so, follow the instructions provided [here](https://github.com/imagej/imagej.github.io/blob/main/_pages/editing/advanced.md).
+If you would prefer to generate a dummy website to make sure it looks exactly as you want before pushing it, you can create your locally served website. To do so, follow the instructions provided for the _imagej.github.io_ pages about [Jekyll and Git](https://github.com/imagej/imagej.github.io/blob/main/_pages/editing/advanced.md).
 
-## Adding and editing member information
+## Quickstart: Adding and editing member information
 Each member have their own markdown file, stored in the `/_members` directory.
-It consist of a YAML frontmatter and markdown text, like this, for the file `simon.noerrelykke.md`:
+It consists of a YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) (between the triple-dashed lines) and document body written in Github flavored [markdown](https://guides.github.com/features/mastering-markdown/). Bellow is an example, for the file `simon.noerrelykke.md`:
 
-```
+```markdown
 ---
 first_name: Simon F.
 last_name: Noerrelykke
 short_name: simon
+city: Zurich
 affiliation: ETH Zurich
 position: Image Analyst
 tags: [matlab, fiji]
@@ -27,20 +27,22 @@ He heads [IDA](http://let-your-data-speak.com/) - the Image and Data Analysis gr
 
 To create a new member file, copy an existing file, rename as `firstName.lastName.md`, change all text that needs changing, and save it in `/_members` (commit it).
 
-Edits can be done directly in your browser in GitHub --- larger changes to structure must be done locally, then pushed to GitHub.
+> Front Matter conventions:
+> * The `city` attribute should only be used for Swiss cities and left empty otherwise. To add a new city not yet present on [the map](https://swissbias.github.io/members/), check out [detailed documentation](https://github.com/SwissBIAS/SwissBIAS.github.io/wiki/How-to-add-yourself-to-the-webpage#the-city-attribute)
+> * The `affiliation` attribute can hold only one institution/company. Use its main name and put the detailed description in the document body.
+
+**Small edits** can be done directly in your browser in GitHub.   
+**Larger changes** to structure must be done locally, then pushed to GitHub (see the [above section](#how-to-contribute). 
 
 That is it!
 The new member will automatically be added to the list of all members and have their own page with the text they provided, e.g. `https://www.swissbias.ch/members/simon.noerrelykke`.
 
-[Here is a guide to markdown on Github](https://guides.github.com/features/mastering-markdown/).
-
-
 ## Adding pages
 To add a webpage, create it as markdown or html and place it in `_pages` (become and editor or create a pull request for this).
 You can link to it from another page or add it to the navigation menu (be conservative -- navigation bars quickly become crowded).
 
 ## Navigation bars
-There are several possible navigation bars, read the documention for whatever Jekyll theme we are using, e.g. [minimal-mistakes](https://github.com/mmistakes/minimal-mistakes).
+There are several possible navigation bars, read the documentation for whatever Jekyll theme we are using, e.g. [minimal-mistakes](https://github.com/mmistakes/minimal-mistakes).
 Pages are added to the top bar by editing the file `navigation.yml` in the `/_data` folder.
 
 # The configuration file

README.md

@@ -11,20 +11,30 @@
 require 'json'
 require 'net/http'
 
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
 
 def get_front_matter_attributes(filepath, attributenames= %w[city affiliation])
   res = {}
+  n = 0
 
-  File.open(filepath, 'r').each_line { |line|
-    parts = line.split(':')
-    if parts
-      attribute = attributenames.delete(parts[0].strip)
-      if attribute
-        res[attribute] = parts[1].strip
+  File.open(filepath, 'r:UFT-8').each_line { |line|
+    if line.strip == '---'
+        n +=  1
+    else
+      puts "read #{line}"
+      parts = line.split(':')
+      if parts
+        attribute = attributenames.delete(parts[0].strip)
+        if attribute
+          res[attribute] = parts[1].strip
+        end
       end
     end
-    break unless attributenames
+    break unless (attributenames and n < 2)
   }
+  puts "#{res}\n\n"
   res
 end
 
@@ -34,15 +44,15 @@ def fetch_coordinates(city, base_url, query_options)
   response = Net::HTTP.get(query)
   result = JSON.parse(response)[0]
   output = [result['lat'].to_f, result['lon'].to_f]
-  puts("Fetched " + city + ": [" + output.join(" ") + "]")
+  puts "Fetched #{city}: [ #{output.join(" ")} + ]"
   output
 end
 
 
 def generate_location_json(pattern, url, options, outpath)
   ca = {}
   Dir.glob(pattern).each { |mdpath|
-    puts("processing file " + mdpath)
+    puts "processing file #{mdpath}"
     fm = get_front_matter_attributes(mdpath)
     city = fm['city']
     city = "Unknown" if city.nil? || city.empty?
@@ -64,7 +74,7 @@ def generate_location_json(pattern, url, options, outpath)
   File.open(outpath, 'w+') {|f|
     f.write "// Generated with #{$PROGRAM_NAME}.\nfunction get_member_locations() {\nreturn " + JSON.pretty_generate(ca) + ";}"
   }
-  puts("Wrote " + outpath)
+  puts "Wrote #{outpath}"
 end
 
 
@@ -75,4 +85,4 @@ def generate_location_json(pattern, url, options, outpath)
 coordinate_api_options = ",+switzerland&format=json&limit=1"
 
 generate_location_json(pages_path_pattern, coordinate_api_base_url, coordinate_api_options, javascript_output_path)
-puts("Done.")
+puts "Done."