Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#874 closed task (fixed)

Translators-Table shows up comments from csv-File

Reported by: fgdrf Owned by: fgdrf
Priority: normal Milestone:
Component: OSGeoLive Keywords: doc
Cc: live-demo@…

Description

the Translators table (http://live.osgeo.org/en/sponsors.html) shows a comment

# please add the names of all translators

from csv file followed by two empty lines.
Properly it would be an enhancement to read the csv directly from rst (see http://docutils.sourceforge.net/docs/ref/rst/directives.html#csv-table for more Details).

We should update the Wiki-Section at http://wiki.osgeo.org/wiki/Live_GIS_Disc#Subversion to describe the columns and the procedure how to add a new committer to the list(s) - translators and contributors.

Change history (5)

comment:1 Changed 8 years ago by camerons

The commented line mentioned above should be removed by the following statement in the doc/Makefile (although it is not seeming to work at the moment)

%.rst: %.csv
	# create contributors.rst and translators.rst from csv files
	echo ".. csv-table::" > $@
	echo "" >> $@
	sed -e 's/^ *#.*//' \
	  -e "s/^/  /" \
	  $< \
	  >> $@

comment:2 Changed 8 years ago by fgdrf

would you agree, that it makes more sense to have native access to the csv-table file than generating an rst from csv? IMHO its easier to maintain a rst file than the sed script within the makefile, isn't it?

comment:3 Changed 8 years ago by fgdrf

Owner: changed from live-demo@… to fgdrf
Status: newassigned

comment:4 Changed 8 years ago by fgdrf

Resolution: fixed
Status: assignedclosed

removed comment lines, created static rst files for contributors and translators that includes the csv files.

In addition, that new contributors/translators know what to add to these file I update the first landing pages in the wiki:

last but not least, the relevant lines were removed from makefile (delete rst files, generate new rst file from csv's etc)

comment:5 Changed 8 years ago by hamish

Cc: live-demo@… added

Hi,

if y'all take ownership of a ticket, please move the mailing list address from the "owner" to the "cc" field or else no one will see your & future comments (unless they happen to dig deep).

the comment line from translators.csv was present in the final .html file because very recently someone checked in a copy of the .csv file which had been saved in Unicode format with byte-order mark binary characters as the first characters in the .csv file (<EF><BB><BF>). This broke the regex which skipped the comment lines (but fwiw with fancier regex, or re-removal of BOM, it could have been repaired).

As the contributor listings tend to get messy, it is desirable to figure a way to re-include the header instructions:

contributors.csv:
# please add the names of everyone with SVN write access to this file
#  - alphabetical by first name
#  - remove punctuation from email addresses to stop harvesting for junk mail
translators.csv:
# please add the names of all translators
#  - Order alphabetically by language, then by first name
#  - remove punctuation from email addresses to stop harvesting for junk mail

I have now resumed the nightly doc builds, preview at:

http://adhoc.osgeo.osuosl.org/livedvd/

(the header-line bolding is nice, can we make the country code column less wide?)

thanks, Hamish

Note: See TracTickets for help on using tickets.