[kde-doc-english] [tellico] /: Add "Minimum Age" and "Playing Time" fields to board game collection
Robby Stephenson
robby at periapsis.org
Sat Jan 16 04:50:24 UTC 2016
Git commit 19906fab2b72ddda70715209de94270e91921ba4 by Robby Stephenson.
Committed on 16/01/2016 at 04:48.
Pushed by rstephenson into branch 'master'.
Add "Minimum Age" and "Playing Time" fields to board game collection
Remove old script for BoardGameGeek and update XSLT for new fields.
Patch from Sven Werlen
REVIEW: 126706
M +3 -1 doc/details.docbook
M +10 -1 src/collections/boardgamecollection.cpp
M +0 -1 src/fetch/scripts/CMakeLists.txt
D +0 -274 src/fetch/scripts/boardgamegeek.rb
M +7 -0 xslt/boardgamegeek2tellico.xsl
http://commits.kde.org/tellico/19906fab2b72ddda70715209de94270e91921ba4
diff --git a/doc/details.docbook b/doc/details.docbook
index 54d18cc..299e811 100644
--- a/doc/details.docbook
+++ b/doc/details.docbook
@@ -505,7 +505,7 @@ Wine collections have 15 default fields.
<sect2 id="board-game-collection">
<title>Board Game Collections</title>
<para>
-Board game collections have 15 default fields.
+Board game collections have 17 default fields.
<emphasis>Title</emphasis>,
<emphasis>Genre</emphasis>,
<emphasis>Mechanism</emphasis>,
@@ -513,6 +513,8 @@ Board game collections have 15 default fields.
<emphasis>Publisher</emphasis>,
<emphasis>Designer</emphasis>,
<emphasis>Number of Players</emphasis>,
+<emphasis>Playing Time</emphasis>,
+<emphasis>Minimum Age</emphasis>,
<emphasis>Description</emphasis>,
<emphasis>Rating</emphasis>,
<emphasis>Purchase Date</emphasis>,
diff --git a/src/collections/boardgamecollection.cpp b/src/collections/boardgamecollection.cpp
index 20765de..f7bb01d 100644
--- a/src/collections/boardgamecollection.cpp
+++ b/src/collections/boardgamecollection.cpp
@@ -82,6 +82,16 @@ Tellico::Data::FieldList BoardGameCollection::defaultFields() {
field->setFlags(Field::AllowMultiple | Field::AllowGrouped);
list.append(field);
+ field = new Field(QLatin1String("playing-time"), i18n("Playing Time"), Field::Number);
+ field->setCategory(i18n(boardgame_general));
+ field->setFlags(Field::AllowGrouped);
+ list.append(field);
+
+ field = new Field(QLatin1String("minimum-age"), i18n("Minimum Age"), Field::Number);
+ field->setCategory(i18n(boardgame_general));
+ field->setFlags(Field::AllowGrouped);
+ list.append(field);
+
field = new Field(QLatin1String("description"), i18n("Description"), Field::Para);
list.append(field);
@@ -120,4 +130,3 @@ Tellico::Data::FieldList BoardGameCollection::defaultFields() {
return list;
}
-
diff --git a/src/fetch/scripts/CMakeLists.txt b/src/fetch/scripts/CMakeLists.txt
index 935aaa7..32f2b9c 100644
--- a/src/fetch/scripts/CMakeLists.txt
+++ b/src/fetch/scripts/CMakeLists.txt
@@ -3,7 +3,6 @@
SET(SCRIPT_FILES
bedetheque.py
- boardgamegeek.rb
dark_horse_comics.py
fr.allocine.py
ministerio_de_cultura.py
diff --git a/src/fetch/scripts/boardgamegeek.rb b/src/fetch/scripts/boardgamegeek.rb
deleted file mode 100755
index 00d61a4..0000000
--- a/src/fetch/scripts/boardgamegeek.rb
+++ /dev/null
@@ -1,274 +0,0 @@
-#!/usr/bin/env ruby
-#
-# ***************************************************************************
-# Copyright (C) 2006-2009 Steve Beattie <sbeattie at suse.de>
-# Copyright (C) 2008-2009 Sven Werlen <sven at boisdechet.org>
-# copyright : (C) 2006 by Steve Beattie
-# : (C) 2008 by Sven Werlen
-# email : sbeattie at suse.de
-# : sven at boisdechet.org
-# ***************************************************************************
-#
-# ***************************************************************************
-# * *
-# * This program is free software; you can redistribute it and/or *
-# * modify it under the terms of the GNU General Public License as *
-# * published by the Free Software Foundation; either version 2 of *
-# * the License or (at your option) version 3 or any later version *
-# * accepted by the membership of KDE e.V. (or its successor approved *
-# * by the membership of KDE e.V.), which shall act as a proxy *
-# * defined in Section 14 of version 3 of the license. *
-# * *
-# * This program is distributed in the hope that it will be useful, *
-# * but WITHOUT ANY WARRANTY; without even the implied warranty of *
-# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
-# * GNU General Public License for more details. *
-# * *
-# * You should have received a copy of the GNU General Public License *
-# * along with this program. If not, see <http://www.gnu.org/licenses/>. *
-# * *
-# ***************************************************************************
-
-# $Id: boardgamegeek.rb 313 2006-10-02 22:17:11Z steve $
-
-# This program is expected to be invoked from tellico
-# (http://periapsis.org/tellico) as an external data source. It provides
-# searches for boardgames from the boardgamegeek.com website, via
-# boardgamegeek's xmlapi interface
-# (http://www.boardgamegeek.com/xmlapi/)
-#
-# It only allows searches via name; the boardgamegeek xmlapi is not yet
-# rich enough to support queries by designer, publisher, category, or
-# mechanism. I'd like to add support for querying by boardgamegeek id,
-# but that needs additional support in tellico.
-#
-# Sven Werlen: 03 Feb 2008: script has been extended to retrieve cover
-# images (/thumbnail from xmlapi). Images are retrieved from the website
-# and base64 is generated on-the-fly.
-#
-require 'rexml/document'
-require 'net/http'
-require 'cgi'
-require "base64"
-include REXML
-
-$my_version = '$Rev: 313 $'
-
-class Game
- attr_writer :year
- attr_writer :description
- attr_writer :cover
- attr_writer :image
-
- def initialize(name, id)
- @name = name
- @id = id
- @publishers = []
- @designers = []
- @genres = []
- @mechanisms = []
- @players = []
- end
-
- def add_publisher(publisher)
- @publishers << publisher
- end
-
- def add_designer(designer)
- @designers << designer
- end
-
- def add_genre(genre)
- @genres << genre
- end
-
- def add_mechanism(mechanism)
- @mechanisms << mechanism
- end
-
- def add_players(players)
- @players << players
- end
-
- def to_s()
- "@name (#@id #@publishers #@year)"
- end
-
- def toXML()
- element = Element.new 'entry'
- element.add_element Element.new('title').add_text(@name)
- element.add_element Element.new('description').add_text(@description) if @description
- element.add_element Element.new('year').add_text(@year) if @year
- element.add_element Element.new('boardgamegeek-link').add_text("http://www.boardgamegeek.com/boardgame/#{@id}") if @id
- element.add_element Element.new('bggid').add_text(@id) if @id
- element.add_element Element.new('cover').add_text(@cover) if @cover
-
- if @publishers.length > 0
- pub_elements = Element.new('publishers')
- @publishers.each {|p| pub_elements.add_element Element.new('publisher').add_text(p)}
- element.add_element pub_elements
- end
- if @designers.length > 0
- des_elements = Element.new('designers')
- @designers.each {|d| des_elements.add_element Element.new('designer').add_text(d)}
- element.add_element des_elements
- end
- if @genres.length > 0
- des_elements = Element.new('genres')
- @genres.each {|d| des_elements.add_element Element.new('genre').add_text(d)}
- element.add_element des_elements
- end
- if @mechanisms.length > 0
- des_elements = Element.new('mechanisms')
- @mechanisms.each {|d| des_elements.add_element Element.new('mechanism').add_text(d)}
- element.add_element des_elements
- end
- if @players.length > 0
- players_elements = Element.new('num-players')
- @players.each {|n| players_elements.add_element Element.new('num-player').add_text(n.to_s)}
- element.add_element players_elements
- end
- return element
- end
-
- def image()
- image = Element.new 'image'
- image.add_attribute('format', 'JPEG')
- image.add_attribute('id', @id + ".jpg")
- image.add_text(@image)
- return image
- end
-end
-
-def getGameList(query)
- #puts("Query is #{query}")
-
- search_result = nil
- Net::HTTP.start('www.boardgamegeek.com', 80) do
- |http| search_result = (http.get("/xmlapi/search?search=#{CGI.escape(query)}",
- {"User-Agent" => "BoardGameGeek plugin for Tellico #{$my_version}"}).body)
- http.finish
- end
- doc = REXML::Document.new(search_result)
-
- ids = []
- games = XPath.match(doc, "//boardgame")
- games.to_a.sort! {|x,y| Integer(x.attributes['objectid']) <=> Integer(y.attributes['objectid'])}
- games.each {|g| ids << g.attributes['objectid']}
- return ids
-end
-
-def getGameDetails(ids)
- #ids.each {|id| puts id}
-
- query = "/xmlapi/boardgame/#{ids.join(',')}"
- #puts query
- search_result = nil
- Net::HTTP.start('www.boardgamegeek.com', 80) do |http|
- search_result = http.get(query, {"User-Agent" => "BoardGameGeek plugin for Tellico #{$my_version}"})
- http.finish
- end
- games = []
- case search_result
- when Net::HTTPOK then
- doc = REXML::Document.new(search_result.body)
-
- games_xml = XPath.match(doc, "//boardgame")
- games_xml.each do |g|
- if( g.elements['name'] != nil )
- game = Game.new(g.elements['name[@primary=\'true\']'].text, g.attributes['objectid'])
- game.year = g.elements['yearpublished'].text
- game.description = g.elements['description'].text
- g.elements.each('boardgamepublisher'){|p| game.add_publisher p.text}
- g.elements.each('boardgamedesigner'){|d| game.add_designer d.text}
- g.elements.each('boardgamecategory'){|c| game.add_genre c.text}
- g.elements.each('boardgamemechanic'){|m| game.add_mechanism m.text}
- minp = Integer(g.elements['minplayers'].text)
- maxp = Integer(g.elements['maxplayers'].text)
- minp.upto(maxp) {|n| game.add_players(n)}
-
- # retrieve cover
- coverurl = g.elements['thumbnail'] != nil ? g.elements['thumbnail'].text : nil
- if( coverurl =~ /^\/\/cf/ )
- coverurl.prepend("http:")
- end
- if( coverurl =~ /http:\/\/([^\/]*)\/(.*)$/ )
- # puts "downloading... " + $2
- cover = nil
- Net::HTTP.start($1, 80) do |http|
- cover = (http.get("/"+$2, {"User-Agent" => "BoardGameGeek plugin for Tellico #{$my_version}"}))
- end
- case cover
- when Net::HTTPOK then
- game.cover = g.attributes['objectid'] + ".jpg";
- game.image = Base64.encode64(cover.body);
- end
- else
- # puts "invalid cover: " + coverurl
- end
- games << game
- end
- end
- end
- return games
-end
-
-def listToXML(gameList)
- doc = REXML::Document.new
- doc << REXML::DocType.new('tellico PUBLIC', '"-//Robby Stephenson/DTD Tellico V10.0//EN" "http://periapsis.org/tellico/dtd/v10/tellico.dtd"')
- doc << XMLDecl.new
- tellico = Element.new 'tellico'
- tellico.add_attribute('xmlns', 'http://periapsis.org/tellico/')
- tellico.add_attribute('syntaxVersion', '10')
- collection = Element.new 'collection'
- collection.add_attribute('title', 'My Collection')
- collection.add_attribute('type', '13')
-
- fields = Element.new 'fields'
- field = Element.new 'field'
- field.add_attribute('name', '_default')
- fields.add_element(field)
- field = Element.new 'field'
- field.add_attribute('name', 'bggid')
- field.add_attribute('title', 'BoardGameGeek ID')
- field.add_attribute('category', 'General')
- field.add_attribute('flags', '0')
- field.add_attribute('format', '4')
- field.add_attribute('type', '6')
- field.add_attribute('i18n', 'true')
- fields.add_element(field)
- collection.add_element(fields)
-
- images = Element.new 'images'
-
- id = 0
- gameList.each do
- |g| element = g.toXML()
- element.add_attribute('id', String(id))
- id = id + 1
- collection.add_element(element)
- images.add_element(g.image());
- end
- collection.add_element(images);
- tellico.add_element(collection)
- doc.add_element(tellico)
- doc.write($stdout, 0)
- puts ""
-end
-
-if __FILE__ == $0
-
- def showUsage
- warn "usage: #{__FILE__} game_query"
- exit 1
- end
-
- showUsage unless ARGV.length == 1
-
- idList = getGameList(ARGV.shift)
- if idList
- gameList = getGameDetails(idList)
- end
-
- listToXML(gameList)
-end
diff --git a/xslt/boardgamegeek2tellico.xsl b/xslt/boardgamegeek2tellico.xsl
index f8a0411..fe72739 100644
--- a/xslt/boardgamegeek2tellico.xsl
+++ b/xslt/boardgamegeek2tellico.xsl
@@ -114,6 +114,13 @@
</xsl:call-template>
</num-players>
+ <playing-time>
+ <xsl:value-of select="playingtime/@value"/>
+ </playing-time>
+
+ <minimum-age>
+ <xsl:value-of select="minage/@value"/>
+ </minimum-age>
</entry>
</xsl:template>
More information about the kde-doc-english
mailing list