mPuu:Käyttöohje

Kohteesta Makijarvi.fi
Loikkaa:valikkoon, hakuun
(en) English version - was spammed beyond repair, sorry.

Tervetuloa mPuu Käyttöhjeeseen! mPuu-ohjelmisto on kehitetty makijarvi.fi sivustojen tekemisen yhteydessä, mutta mPuu-konsepti on kenen tahansa käytettävissä samoin ehdoin kuin kaikki muukin materiaali makijarvi.fi sivustoilla. mPuu-ohjelmisto on myös vapaasti käytettävissä GPL2 license ehtojen mukaisesti.

Esittely

mPuu tulee sanoista Mäkijärvi Sukupuu. Se standardisoi kuinka henkilötietoja kerätään ja esitetään kustakin suvun henkilöstä. Yhtenäisen tiedon esitystavan ansiosta, sitä voidaan käyttää erilaisissa ohjelmasovelluksissa. mPuu sisältää useita erilaisia sovelluksia, kuten esimerkiksi ohjelman, joka luo sukupuu grafiikkaa automaattisesti.

Onko mPuu minulle sopiva työkalu?

Luultavasti ei. Ehkä, jos olet päättänyt tehdä Wikin suvullesi. Kaikista eri wiki-ohjelmista olet kiinnostunut MediaWiki-ohjelmistosta jota käytetään Wikipedia-projektissa, etkä pelästy tämän vaikeahkon ohjelman edessä. Olet myös ehkä katsonut esimerkiksi WikiTree projektia ja pitänyt muutamista asioista siellä. Et ole aivan kuolemanvakava genealogian kanssa, mutta haluat paremminkin kertoa sukusi tarinan. Sinulla on web-hotellin kautta tai muulla tavalla pääsy LAMP-serveriin (Linux-Apache-MySQL-PHP), etkä ole sormi suussa komentorivin edessä. Kyllä, saatat ehkä haluta lukea pidemmälle.

Mitä mPuu oikein tekee?

mPuu

Kaikille sivutojen henkilöille luodaan mallineita käyttäen navigointitaulukko, jota kutsutaan Henkilökortiksi. Sen avulla voi navigoida sivusta toiseen samassa MediaWiki luokassa, yleensä Henkilöt. Henkilökorttia käytetään myös luomaan XML-tietokanta. Joukkoa ohjelmia käytetään hakemaan tietoja tietokannasta. Ohjelmat piirtävät, muitten toimintojen ohella, kaikille tietokannassa esiintyville henkilöille oman, henkilökohtaisen sukupuun. Graafisia esityksiä, listoja paikoista joissa henkilöt ovat asuneet ja vastaavaa tietoa voidaal lukea takaisin tietokannasta suoraan MediaWikin sivuilla esitettäväksi. Oikealla olevaa kuvaa klikkaamalla voit lukea tarkan toimintakuvauksen.

Katso esimerkiksi joku henkilö makijarvi.fi sivustoilta, vaikkapa Ivar Mäkijärvi, tai katso Mäkijärven A0-kokoinen sukupuu nähdäksesi mPuu-ohjelman toiminnassa.

Asennus

Arvasit oikein, tässä on lista kaikista ohjelmista ja resursseista joiden tulee olla asennettuna LAMP-serverissä ennen kuin voit jatkaa eteenpäin.

  • Melkein mikä tahansa Linux-palvelin käy, kernelit 2.4 ja 2.6
  • Apache httpd palvelin. Useimmat webbihotellit käyttävät oletuksena versiota 1.3.x, mutta jos asennat palvelinta itse, mikään ei estä sinua asentamasta Apache versiota 2.0.x tai vielä uudempaa.
  • MySQL tietokanta. Jälleen kerran tämä valinta on usein webbihotellin tekemä, ja useimmat niistä ajavat versiota 4.x, mutta myös versioita 5.x alkaa jo näkyä. Molemmat käyvät.
  • PHP moduuli php_mod Apache serverille. Jos vielä käytät webbihotellia, jossa pidetään versiota 4.x, olisi syytä vaihtaa palvelinta. MediaWikin uusimmat versiot tarvitsevat PHP 5.1.x tai uudemman. Jos sinulla on levytilaa, voit myös kääntää oman PHP-versiosi ja ajaa sitä CGI-prosessina.
  • MediaWiki tietenkin! Haluat varmasti käyttää versiota 1.11.0 tai uudempaa.
  • Graphviz AT&T:ltä tekee näyttävää webbigrafiikkaa tietokannan tiedoista. Tarvitsemme vain dot nimisen sovelluksen paketista mutta on paljon helpompaa asentaa koko paketti. Tätä ei löydy yleensä mistään webbihotellista, joten joudut asentamaan sen omaan levytilaasi. Tarvitset version 2.8 tai uudemman.
  • Python 2.2 tai uudempi. Olisi aika outoa, jos Pythonia ei olisi asennettu. Tosin siitä voi puuttua joitakin XML-parseri moduuleja. Joten jos vain levytilaa on käytössä, olisi ehkä parempi asentaa oma Python-version, jossa on tarvittava Sax XML-parseri.

Seuraava asennusohje on tehty kotihakemistoasi ajatellen webbihotellissa. Ne joilla on oma virtuaali tai ihkaoikea serveri, voivat muuttaa $HOME polun /usr/local + jotakin.

Asenna mPuu paketti

Ok, olet siis saanut MediaWiki ylös ja toimimaan? Tämä on hyvä paikka asentaa mPuu paketti ja kokeilla sitä.

  • Nouda mPuu paketti. (2018: siirretty GitHub-saitille local SVN:stä, alkaen tagista v2.0.0)
    • Uusin versio on 1.1.0
    • Paketti on bz2-pakattu tar tiedosto
    • Valitettavasti EXE- tai ZIP-versioita ei ole saatavana
  • Siirrä paketti palvelimesi $HOME hakemistoon (tai /usr/local jos olet järjestelmävastaava).
  • Asenna paketin versiohakemisto ja tee symboolinen linkki siihen
cd $HOME
tar xvjf mPuu-1.1.0.tar.bz2
ln -s mPuu-1.1.0 mPuu

Valmistele mPuu tietokannan hakemistorakenne

Oletetaan että kysymyksessä on tyypillinen webbihotelli, jossa Apache web-palvelin hakee sivut $HOME/www hakemistosta. Mikäli ajat PHP:tä Apachen php_mod moduulin kautta, joidenkin hakemistojen tulee olla httpd prosessin omistajan kirjoitettavissa. Siinä tapauksessa tarvitset alla esitettävän kirjoituksen sallimisen kaikille prosesseille.

cd $HOME/www
mkdir -p mPuu/db/pi
chmod 777 mPuu/db/pi
mkdir -p mPuu/graphs/pt
mkdir mPuu/graphs/ft
mkdir mPuu/spam
chmod 777 mPuu/spam
mkdir mPuu/temp
chmod 777 mPuu/temp
mkdir -p mPuu/xhtml/houses
mkdir mPuu/xhtml/towns
Huomatus: Valitettavasti meillä ei ole toistaiseksi edes yksinkertaista skriptiä antaa ylläolevaan tehtävään toistaiseksi. Mutta jos leikkaa ja liimaat ylläolevan palvelimen komentoriville, ei se ehkä niin vaikeaa kuitenkaan ole.

Asenna mPuu MediaWiki Extension

Seuraavassa oletamme, että ole asentanut MediaWikin $HOME/www/wiki hakemistoon ja mPuu paketti on asennettu $HOME hakemistoon yllä olevissa kappaleissa esitettyjen ohjeiden mukaan. MediaWikin ja mPuu paketin kahdenkeskinen asema on tärkeä, koska alla olevassa ohjeessa käytämme suhteellista hakemistopolkua.

Tee symboolinen linkki MediaWikin extensions hakemistossa siten, että se osoittaa mPuu paketin MediaWiki extensions hakemistoon ja siellä mPuu.php ohjelmamoduuliin.

cd $HOME/www/wiki/extensions
ln -s ../../../mPuu/extensions/mPuu.php .

Muokkaa MediaWikin konfigurointitiedostoa $HOME/www/wiki/LocalSettings.php. Lisää seuraavat rivit tiedoston loppuun:

# The mPuu management extension
require_once("extensions/mPuu.php");

Talleta tiedosto. Jos sinulla on nyt jokin ongelma mPuu MediaWiki extensionin kanssa, tulee se ilmi aivan heti, sillä kaikki sivunäytöt käyvät katsomassa mPuu ohjelmamoduulia. Jos jokin parserivirhe syntyy, ei sivustoilta tule siis yhtään sivua ulos. Jos tällainen virhe esiintyy, riittää kun kommentoit pois lisätyn require_once() rivin MediaWikin konfigurointitiedostosta.

mPuu MediaWiki extensionin ohjelmointi tapahtuu muokkaamalla itse lähdekoodimoduulin alkuosiota tiedostossa $HOME/mPuu/extensions/mPuu.php. Jokainen extension-osio sisältää omat parametrinsa. Etsi -- Configuration -- tekstiä kunnes pääset tiedoston loppuun. Jos sinulla on yllä ehdotettu hakemistoratkaisu, ehdotettuja tiedostopolkuja ei tarvitse muuttaa. Muussa tapauksessa laita niiden sijaan omat suhteelliset tiedostopolkusi.

Mielenkiintoinen osio on spam-filtteri, joka on itseasiassa yksinkertainen musta lista, joka on sisälletty mPuu MediaWiki extensioniin. Voit määritellä kiellettyjä sanoja tai nimiä kahdessa listassa, spamWords ja blacklistedPersons. Suodattimen toiminta on varsin yksinkertaista; jos artikkelissa on sana tai sanoja mustista listoista, artikkelia ei voi tallentaa.

Joudut käymään läpi useita -- Configuration -- osioita, valitamme työmäärää. Huomaa, että sinun tulee antaa myös (s)cgi-bin skriptien sijainti muuttujassa $mPuuCgiBinURL. Sinun ei tarvitse muuttaa $mPuuXmlns ja $mPuuSchemaLocation. Ne voivat osoittaa edelleen ohjemiston kotisaitillle. Sinun ei tarvitse tallettaa omaa kopiotasi XMLSchemasta.

Asenna (s)CGI-BIN ohjelmat

Yleensä webbihotellissa on turvallisuuden kannalta varminta, että cgi-bin ohjelmat ajetaan omalla käyttäjätunnuksellasi. Tämä tehdään yleensä ns. wrapper'-ohjelman avulla, joka etsii suoritettavaa ohjelmaa scgi-bin hakemistosta. Jos tämä järjestely ei kuitenkaan ole käytössä, käytä oletusarvona olevaa cgi-bin hakemistoa. Esimerkissämme:

cd $HOME/www/scgi-bin
cp $HOME/mPuu/scgi-bin/*.py .

Huomaa, että tässä hakemistossa ei voi tehdä symbolisia linkkejä vaan että tiedostojen on oltava tässä hakemistossa läsnä. Ns. kovia- eli levytiedostolinkkejä voi kyllä käyttää, jos niin haluat. Yllä kuitenkin vain kopioimme tarvittavat ohjelmat.

Aseta Python cgi-bin ohjelmien käsittelijäksi

Varsin yksinkertaista, mutta silti, muokkaa tiedostoa $HOME/www/.htaccess ja lisää siihen seuraava osio (jos sellaista ei jo siellä ole)

# Do not allow our users to browse directories
Options -Indexes

# We will run some Python scripts as CGI
AddHandler cgi-script .py

Konfiguroi mPuu offline sovellukset

Siirry hakemistoon $HOME/mPuu/lib ja muokkaa konfigurointitiedostoa mPuuConfiguration.py. Se sisältää muutamia oletusarvoja, joista useimmat käyvät sellaisenaan asentamaasi järjestelmään. Mutta muista kuitenkin käydä ne läpi ja muuttaa kaikkein selvimpiä konfigurointi argumentteja, kuten

# Site's URL to the MediaWiki main index.php file
#
self.siteURL = 'http://www.makijarvi.fi/wiki/index.php'

Testaa mPuu offline sovellukset ja tee niistä crontab

Kun olet luonut muutaman henkilökortin ja näet jo uusia XML-tiedostoja syntyvän hakemistoon $HOME/mPuu/db/pi, voit ryhtyä testaamaan mPuu offline sovellusohjelmia. Voit esimerkiksi ajaa henkilökohtaisen sukupuun tuottavan ohjelman $HOME/mPuu/bin/mpuu-pigraphs.py:

cd $HOME/mPuu/bin
./mpuu-pigraphs.py --help
./mpuu-pigraphs.py --verbose

Kun olet ajanut ohjelmat ainakin kerran komentoriviltä siten, että ne eivät lähettele virheviestejä konsolille vaan toimivat kaikessa hiljaisuudessa, voit laittaa ne cron-job listaan niin että ne ajetaan öiseen aikaan. Esimerkiksi,

MAILTO="your.name@mydomain.com"
22 2 * * * /bin/rm -f /home/myhomedir/public_html/mPuu/temp/*
13 3 * * * /home/myhomedir/mPuu/bin/mpuu-pigraphs.py
43 3 * * * /home/myhomedir/mPuu/bin/mpuu-ftgraphs.py
18 4 * * * /home/myhomedir/mPuu/bin/mpuu-places.py
33 4 * * * (cd /home/myhomedir/www;/bin/rm -f sitemap-*;/usr/local/bin/php /home/myhomedir/www/wiki/maintenance/generateSitemap.php www.mydomain.com >/dev/null 2>&1)

Vaihda ylläolevassa absoluuttinen hakemistopolku omalla $HOME hakemistollasi. Muista että pitkienkin rivien tulee olla vain yhdellä rivillä. Jos et pidä pitkistä riveistä, kirjoita scripti ja aja se. Kun sivustosi kasvaa, voi esimerkiksi mpuu-pigraphs.py ajaminen kestää niin kauan, että webbihotellisi ampuu se alas lennosta. Katso ko. ohjelman optioita; huomaat että sen voi ajaa useassa osassa, aakkosellisesti.

Luo mPuu nimiavaruus

Muokkaa asennuksesi $HOME/www/wiki/LocalSettings.php konfigurointitiedostoa, lisäten siihen uusi nimiavaruus seuraavan esimerkin mukaisesti:

# Extra name spaces for this Wiki
$wgExtraNamespaces =
       array(100 => "mPuu",
             101 => "mPuu_Keskustelu",
             );

Voit käyttää myös muita ID-numeroita, mutta muista että se vaikuttaa import/export toimintaan. Tämän ohjelmistopaketti sisältää ylläolevan nimiavaruuden artikkeleita. Jos muutat nimiavaruuden ID-numeroita, sinun täytyy käsin muokata myös paketin XML-tiedostoa siten, että se vastaa antamaasi uutta ID-numeroa. Katso mPuu:Käyttöohje#XML-export/import alla.

XML-export/import

Käytä MediaWikin toimintoa Tuo sivuja lukeaksesi tietokantaan kaikki mPuu-ohjelmistoa tukevat sivut. Sinun täytyy olla vähintään sivustojesi SysAdmin voidaksesi tehdä sisäänluvun.

Varoitus! - Tämä proseduuri ajaa ylitse CSS stylesheetin nimeltä MediaWiki:Monobook.css (joka on oletusarvona kaikissa MediaWiki asennuksissa). Jos olet jo muuttanut tätä tiedostoa MediaWikin tietokannassa, talleta muutoksesi niin, että voit lisätä ne uuteen stylesheetiin, jossa on mPuu-ohjelmiston muutokset. Nähdäksesi listan kaikista tiedostoista jotka luodaan tietokantaan, katso mPuu:XML Import List

Talleta XML-tiedosto nimellä $HOME/mPuu/extensions/mPuuTuonti.xml niin että voit lukea sen selaimesi kautta. Valitse MediaWikisi toimintosivuilta Tuo sivuja. Valitse mPuu XML-sivu.

Käyttö

Uusien sivujen myötä olet ladannut myös käyttöohjeen MediaWiki asennukseesi. Katso esimerkiksi Ohje:Henkilötietojen luominen, joka on ehkä tärkein mPuu mallineista (katso Malline:Uusi henkilö). Selaa Toiminnot - > Kaikki sivut -> Ohje sivuja nähdäksesi muitten tärkeiden mallineitten käyttöohjeet.

Mallineiden sisällä on useita pienempiä mallineita, joista ei ole olemassa erillistä käyttöohjetta. Jos haluat tarkempaa tietoa näistä mallineista, katso teknistä dokumentaatiota kunkin mallineen keskustelu-osiosta.

Versiot ja tunnetut bugit

Ole hyvä ja katso sivu Mpuu Version Page (pois käytöstä)

Apua

Kirjoittaudu käyttäjäksi tälle mPuu (originaalille) sivustoille. Käytä ylläolevaa keskustelusivua esittääksesi kysymyksiä ohjelmistosta. Ohjelmistotukea annetaan parhaalla mahdollisella tavalla. Mutta älä hermostu, jos vastausta ei kuulu lähimmän tunnin aikana. Vastaamme kyllä kaikille ja yritämme parhaamme auttaaksemme sinua.