LordSputnik

Documentation Guidelines

Purpose

This guideline is designed to help people write pages of documentation that fit in well with the rest of the BookBrainz user guide. A section on general documentation guidelines is followed by advice for writing specific types of documents. It is hoped that through this guideline, the BookBrainz documentation can remain more consistent and easier to use.

General Guidelines

This section describes general guidelines you should follow when writing any type of documentation.

• Titles - Try not to use more than the three levels of headings. Text with lots of levels can be hard to understand, and generally covers too much material. Headings should be capitalized just like an Edition alias in BookBrainz - generally, first letters of words should be capitalized, apart from for specific words.
• Clarity - Documentation should be very easy to understand, so sections should be as simple as possible. If a section becomes too long, move it to a new page and leave a shor

LordSputnik

var knex = require('knex')({
  client: 'postgresql',
  connection: {
    host     : '127.0.0.1',
    user     : 'username',
    password : 'password',
    database : 'database'
  }
});

LordSputnik

ben@Mithrandir:~/Music/FLAC/CDs$ ./MassTagger
Boost Version: 1_49
Last Req: 1353686977
Returning from MB
D�cal�|Décalé!
Last Req: 1353686978
Returning from MB
Last Req: 1353686980
Returning from MB
You're Not the First|You’re Not the First!

LordSputnik

    /* So, what stuff regularly needs updating in my library? Everything? No...
    * Recording
    *   Artist Name
    *   Album Name
    * Release
    *   Album Art -> libcoverart
    *   Release Date
    *   Original Release Date
    *   Track Number/Total
    *   Disc Number/Total

LordSputnik

function getWikiText(o, callback) {
	if (!o['relations']) {
		callback('');
		return;
	}
	
	var wikiLink;
	for (var i = 0; i < o['relations'].length; ++i) {
		if (o['relations'][i]['type'] == 'wikipedia') {
			wikiLink = parseURL(o['relations'][i]['url']);

LordSputnik

Verifying that +benockmore is my blockchain ID. https://onename.com/benockmore

LordSputnik

mkdir calibre_build && cd calibre_build && wget https://github.com/stasszczesniak/CalibreBookBrainzPlugin/archive/master.zip && unzip master.zip && cd CalibreBookBrainzPlugin-master && zip -r calibre_test.zip ./ && mv calibre_test.zip ../../ && cd ../../ && rm -Rf calibre_build

LordSputnik

Using the "schema" of:

http://yuml.me/edit/86aaba0d

Entity

Creating an Entity

1. Insert row into entity table ()
2. Insert row into revision table ()
3. Insert row into <entity>_data table (...data)
4. Insert row into <entity>_header table (bbid)

LordSputnik

from collections import defaultdict
import copy
import json

simulated_release = {
    "artist":"The Beatles",
    "title":"Collection of Random Hits",
    "mbid":3,
    }

LordSputnik

def client_authentication_required(self, request, *args, **kwargs):
    return False