Difference between revisions of "Extension Packages"

From EPrints Documentation
Jump to: navigation, search
m
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[http://note.rigour.info/content/view/trucchi-giochi.htm trucchi giochi xbox] [http://load.rigour.info/view/new/santa-fe.htm santa fe hyundai] [http://here.rigour.info/blog/archeologia-a.htm archeologia a perugia] [http://uve.rigour.info/blog/excape.htm excape] [http://it.rigour.info/topic/tabella-millesimale/ tabella millesimale] [http://content.rigour.info/html/microfono-ps/ microfono ps2] [http://it.rigour.info/topic/lotus-esprit/ lotus esprit 2.2] [http://down.rigour.info/blog/fiale-per.htm fiale per capelli] [http://gratis.rigour.info/content/view/aspirapolvere-con.htm aspirapolvere con battitappeto] [http://italy.rigour.info/blog/decoder-con.htm decoder con contributo statale] [http://dir.rigour.info/rsmmc-dv/ rs-mmc dv per nokia 6630 512] [http://guest.rigour.info/library/html/posizione/ posizione 69] [http://blog.rigour.info/web/bracciale-topazio/ bracciale topazio argento] [http://gratis.rigour.info/content/view/occidentale-papua.htm occidentale (papua nuova guinea)] [http://dir.rigour.info/cuba-e/ cuba e lavana] [http://uve.rigour.info/blog/tre-gendarmi.htm tre gendarmi a new york] [http://up.rigour.info/description/lib/happy-di.htm happy di clinique] [http://dir.rigour.info/roiate/ roiate] [http://uve.rigour.info/blog/toyota-paseo.htm toyota paseo] [http://it.rigour.info/topic/quiz-patente/ quiz patente] [http://gratis.rigour.info/content/view/viaccess-key.htm viaccess key 20 11 2004] [http://blog.rigour.info/web/live-in/ live in hyde park] [http://web.rigour.info/mediterraneo-colonna/ mediterraneo colonna sonora film] [http://note.rigour.info/content/view/www-bassanodelgrappa.htm www bassanodelgrappa it] [http://online.rigour.info/olympus-fotocamera/ olympus fotocamera digitale 5 0] [http://gratis.rigour.info/content/view/citta-di.htm citta di pisa] [http://content.rigour.info/html/mr-funky/ mr funky] [http://online.rigour.info/uv-lampada/ uv lampada] [http://here.rigour.info/blog/crypt.htm crypt] [http://web.rigour.info/super-ciro/ super ciro] [http://pagina.rigour.info/ver-el/ ver el video de tardes negras] [http://down.rigour.info/blog/deep-purple.htm deep purple child in tima] [http://up.rigour.info/description/lib/sara-maldonado.htm sara maldonado] [http://pagina.rigour.info/world-rally/ world rally championship ii extreme] [http://gratis.rigour.info/content/view/www-msn.htm www msn com] [http://up.rigour.info/description/lib/iovine-patrizia.htm iovine patrizia] [http://here.rigour.info/blog/grace-of.htm grace of my heart] [http://down.rigour.info/blog/foto-di.htm foto di misilmeri] [http://all.rigour.info/www-alessandro/ www alessandro preziosi it] [http://here.rigour.info/blog/testi-delle.htm testi delle canzoni dei 24 grana] [http://load.rigour.info/view/new/bubble-bobbe.htm bubble bobbe 2] [http://here.rigour.info/blog/matriosca.htm matriosca] [http://pagina.rigour.info/chacker/ chacker] [http://speed.rigour.info/vdo-dayton.htm vdo dayton 2604] [http://note.rigour.info/content/view/bachatahits.htm bachatahits] [http://blog.rigour.info/web/citofono/ citofono] [http://uve.rigour.info/blog/titanic-mp.htm titanic mp3 titanic] [http://milano.rigour.info/fronte-dal.htm fronte dal palco live] [http://web.rigour.info/jura/ jura 385] [http://here.rigour.info/blog/classe-a.htm classe a lavastoviglie] [http://gratis.rigour.info/content/view/kapula.htm kapula] [http://blog.rigour.info/web/canon-mm/ canon 50mm 1 8] [http://here.rigour.info/blog/canadiangirl.htm canadiangirl] [http://dir.rigour.info/yala/ yala] [http://milano.rigour.info/cowboy-bebop.htm cowboy bebop. vol. 03] [http://pagina.rigour.info/ultimo-cd/ ultimo cd degli u2] [http://pagina.rigour.info/sandisk-mp/ sandisk mp3] [http://here.rigour.info/blog/buongiorno-napoli.htm buongiorno napoli] [http://speed.rigour.info/alberghi-treviso.htm alberghi treviso] [http://milano.rigour.info/nec-lcd.htm nec lcd 15] [http://up.rigour.info/description/lib/siti-internet.htm siti internet lecco] [http://italy.rigour.info/blog/juliana-big.htm juliana big brother] [http://down.rigour.info/blog/giochi-nuovi.htm giochi nuovi] [http://content.rigour.info/html/immagini-talpa/ immagini talpa con paola perego] [http://paga.rigour.info/cinzia-molena/ cinzia molena nuda] [http://content.rigour.info/html/kokkola/ kokkola] [http://dir.rigour.info/accessori-bambini/ accessori bambini] [http://dir.rigour.info/pioneer-dehmp/ pioneer deh-4700mp] [http://paga.rigour.info/pc-siemens/ pc siemens] [http://blog.rigour.info/web/brazil/ brazil] [http://down.rigour.info/blog/sblocco-z.htm sblocco z1010] [http://dir.rigour.info/bmw/ bmw 525] [http://content.rigour.info/html/screesavers/ screesavers] [http://blog.rigour.info/web/fiat-punto/ fiat punto elx 5p 2000] [http://all.rigour.info/lingeries/ lingeries] [http://guest.rigour.info/library/html/outcast/ outcast] [http://note.rigour.info/content/view/marley-dvd.htm marley dvd] [http://here.rigour.info/blog/impresa-lombardia.htm impresa lombardia] [http://paga.rigour.info/giovane/ giovane] [http://online.rigour.info/stafania-orlando/ stafania orlando] [http://dir.rigour.info/fz/ fz 61 1] [http://down.rigour.info/blog/suker-per.htm suker per sempre] [http://gratis.rigour.info/content/view/yugioh-dawn.htm yu-gi-oh dawn of destiny] [http://online.rigour.info/viridiana/ viridiana] [http://it.rigour.info/topic/router-adsl/ router adsl 125 mbps] [http://up.rigour.info/description/lib/austrodaimler.htm austro-daimler] [http://pagina.rigour.info/hotel-economici/ hotel economici madrid] [http://milano.rigour.info/interattivo.htm interattivo] [http://content.rigour.info/html/foto-scooter/ foto scooter preparati] [http://pagina.rigour.info/izoard-col/ izoard, col d-] [http://it.rigour.info/topic/costo-rottame/ costo rottame] [http://gratis.rigour.info/content/view/karan-goran.htm karan goran] [http://dir.rigour.info/figaro-le/ figaro, le-] [http://guest.rigour.info/library/html/calcolo-isee/ calcolo isee] [http://note.rigour.info/content/view/scanner-lg.htm scanner lg 600] [http://note.rigour.info/content/view/panasonic-dp.htm panasonic dp 2310] [http://dir.rigour.info/www-taglia/ www taglia42 it] [http://here.rigour.info/blog/video-karaoke.htm video karaoke italia gratis] [http://down.rigour.info/blog/trani-a.htm trani a gogo] [http://web.rigour.info/morte-lorna/ morte lorna] [http://it.rigour.info/topic/svije/ svije] [http://load.rigour.info/view/new/archie-shepp.htm archie shepp. quartet. part 2] [http://uve.rigour.info/blog/il-mare.htm il mare derba] [http://up.rigour.info/description/lib/thief-.htm thief 3 - trailer] [http://content.rigour.info/html/la-cantante/ la cantante dei black eyes peas] [http://content.rigour.info/html/www-scienze/ www scienze uniba it] [http://dir.rigour.info/cranberries-zombi/ cranberries zombi] [http://web.rigour.info/fscaller/ fscaller] [http://paga.rigour.info/pulangkanlah/ pulangkanlah] [http://gratis.rigour.info/content/view/betsabe.htm betsabe] [http://paga.rigour.info/tinto-rosse/ tinto rosse] [http://pagina.rigour.info/ilocos-norte/ ilocos norte] [http://speed.rigour.info/case-rustiche.htm case rustiche] [http://load.rigour.info/view/new/bormio-albergo.htm bormio albergo] [http://load.rigour.info/view/new/zoom-.htm zoom 90 calcio] [http://load.rigour.info/view/new/finanziamenti-fondo.htm finanziamenti fondo perduto] [http://guest.rigour.info/library/html/test-sul/ test sul futuro] [http://here.rigour.info/blog/contenido-de.htm contenido de la letra de cambio] [http://pagina.rigour.info/foredil-brescia/ foredil brescia] [http://guest.rigour.info/library/html/harrods-it/ harrods it com] [http://pagina.rigour.info/estados-unidos/ estados unidos] [http://speed.rigour.info/vigliaccheria.htm vigliaccheria] [http://gratis.rigour.info/content/view/toolbox.htm toolbox] [http://it.rigour.info/topic/starray/ starray] [http://dir.rigour.info/karma-malo/ karma malo malo pomalo] [http://it.rigour.info/topic/tastiera-touch/ tastiera touch] [http://blog.rigour.info/web/comprar-vivienda/ comprar vivienda] [http://up.rigour.info/description/lib/testo-della.htm testo della canzone universal prayer] [http://paga.rigour.info/escape-from/ escape from monkey island] [http://gratis.rigour.info/content/view/nortek-lettore.htm nortek lettore di mp3 1gb] [http://content.rigour.info/html/mirage-paps/ mirage paps] [http://here.rigour.info/blog/due-nuovi.htm due nuovi filmati per gran turismo 4] [http://note.rigour.info/content/view/opel-astra.htm opel astra 1 7] [http://uve.rigour.info/blog/bilancia-philips.htm bilancia philips] [http://it.rigour.info/topic/edizione-gold/ edizione gold per rise of nations] [http://note.rigour.info/content/view/eugene-amstrong.htm eugene amstrong video] [http://blog.rigour.info/web/albergo-forli/ albergo forli] [http://down.rigour.info/blog/olio-essenziale.htm olio essenziale di limone] [http://guest.rigour.info/library/html/apoteosi/ apoteosi] [http://uve.rigour.info/blog/t-shirt.htm t shirt maniche lunghe donna] [http://content.rigour.info/html/frisinga/ frisinga] [http://note.rigour.info/content/view/stampante-hp.htm stampante hp 450] [http://load.rigour.info/view/new/tendina-giordani.htm tendina giordani] [http://here.rigour.info/blog/ddr-notebook.htm ddr notebook] [http://web.rigour.info/tenda-/ tenda 3 persone] [http://speed.rigour.info/robbie-wilson.htm robbie wilson] [http://web.rigour.info/kosheen-catch/ kosheen catch you] [http://paga.rigour.info/www-fica/ www fica] [http://gratis.rigour.info/content/view/etq.htm etq] [http://guest.rigour.info/library/html/heiltsuk/ heiltsuk] [http://note.rigour.info/content/view/mutandina-usata.htm mutandina usata] [http://dir.rigour.info/fuori-strada/ fuori strada subaru] [http://online.rigour.info/dirty-dancing/ dirty dancing] [http://down.rigour.info/blog/xu.htm xu 440] [http://it.rigour.info/topic/lettore-dvd/ lettore dvd home theatre] [http://note.rigour.info/content/view/asus-pp.htm asus p4p800 x] [http://gratis.rigour.info/content/view/router-adsl.htm router adsl zyxel] [http://guest.rigour.info/library/html/piccolo-uomo/ piccolo uomo] [http://pagina.rigour.info/natalia-millan/ natalia millan] [http://paga.rigour.info/halmahera/ halmahera] [http://italy.rigour.info/blog/pagina-iniziale.htm pagina iniziale] [http://note.rigour.info/content/view/my-immortal.htm my immortal nuova versione] [http://online.rigour.info/orchidea/ orchidea 71] [http://up.rigour.info/description/lib/franz-listz.htm franz listz] [http://here.rigour.info/blog/miroslav.htm miroslav] [http://online.rigour.info/altavilla/ altavilla] [http://milano.rigour.info/philips.htm philips 7630] [http://it.rigour.info/topic/logitech-desktop/ logitech desktop ex 100] [http://milano.rigour.info/musoduro.htm musoduro] [http://down.rigour.info/blog/robbie-willims.htm robbie willims] [http://here.rigour.info/blog/mare-di.htm mare di piu] [http://gratis.rigour.info/content/view/caldaie-ricambi.htm caldaie ricambi napoli] [http://guest.rigour.info/library/html/southwest-com/ southwest com] [http://blog.rigour.info/web/ona-je/ ona je poput djeteta 100 na jednoga] [http://blog.rigour.info/web/jeep-nuova/ jeep nuova grand cherokee 2005] [http://dir.rigour.info/herramientas-de/ herramientas de negociacion] [http://gratis.rigour.info/content/view/clubprive-milano.htm clubprive milano] [http://up.rigour.info/description/lib/mpe-mm.htm mp-e 65mm] [http://all.rigour.info/asphalt-urban/ asphalt urban gt2] [http://web.rigour.info/pro-evolution/ pro evolution soccer 4 scontato a fine mese] [http://here.rigour.info/blog/www-enature.htm www enature net] [http://content.rigour.info/html/meteo-biella/ meteo biella] [http://milano.rigour.info/regina-elisabetta.htm regina elisabetta] [http://paga.rigour.info/sia-di/ sia di fornaci] [http://dir.rigour.info/immagini-o/ immagini o foto del kamasutra] [http://content.rigour.info/html/corvo-torvo/ corvo torvo] [http://content.rigour.info/html/fiat-scudo/ fiat scudo jtd] [http://speed.rigour.info/abito-firmato.htm abito firmato] [http://content.rigour.info/html/nx/ nx6110 740] [http://content.rigour.info/html/sen-kombi/ sen kombi] [http://uve.rigour.info/blog/canzone-california.htm canzone california dei phantom planet] [http://here.rigour.info/blog/hamsterball.htm hamsterball] [http://web.rigour.info/www-un/ www un posto al sole com] [http://speed.rigour.info/sunshine-baby.htm sunshine baby] [http://content.rigour.info/html/la-spada/ la spada del deserto] [http://speed.rigour.info/www-verona.htm www verona volley it] [http://blog.rigour.info/web/viava-la/ viava la pappa] [http://online.rigour.info/periyar/ periyar] [http://online.rigour.info/funkytown/ funkytown] [http://note.rigour.info/content/view/kreuk.htm kreuk] An extension package is a .tgz file containing multiple files which adds a suite of functionality when unpacked in the /opt/eprint3 directory.
+
[[Category:Contribute]]
 +
[[Category:Plugins]]
 +
An extension package is a .tgz file containing multiple files which adds a suite of functionality when unpacked in the /opt/eprint3/archives/ARCHIVE_ID/ directory.
  
 
An extension can be as simple as a plugin plus a css file or add a whole exciting suite of new features.
 
An extension can be as simple as a plugin plus a css file or add a whole exciting suite of new features.
Line 5: Line 7:
 
Things you might want to put into an eprints extension package:
 
Things you might want to put into an eprints extension package:
  
* Plugins: perl_lib/EPrints/Plugin/...
+
* Plugins: archives/ARCHIVE_ID/cfg/plugins/EPrints/Plugin/...
 
* Themes: lib/themes/...
 
* Themes: lib/themes/...
* scripts: bin/...
+
* scripts: archives/ARCHIVE_ID/bin/...
* CGI scripts: cgi/...
+
* CGI scripts: archives/ARCHIVE_ID/cgi/...
* autocompletion scripts: cgi/users/lookup/...
+
* autocompletion scripts: archives/ARCHIVE_ID/cgi/users/lookup/...
* phrase files for use by plugins or scripts: lib/lang/.../phrases/...
+
* phrase files for use by plugins or scripts: archives/ARCHIVE_ID/cfg/lang/.../phrases/...
* images, icons, javascript and css files to support your plugins or scripts: lib/static/...
+
* images, icons, javascript and css files to support your plugins or scripts: archives/ARCHIVE_ID/cfg/static/...
  
 
Other things you might want to include are...
 
Other things you might want to include are...
Line 17: Line 19:
 
* repository specific phrase files
 
* repository specific phrase files
 
* autocompletion data files
 
* autocompletion data files
...but these can't be installed directly as they must go in the repository specific directory: archives/ARCHIVEID/cfg/
 
If you have more than 2 files to go in the archive cfg dir you may consider including a second .tgz file to unpack in archives/ARCHIVEID/cfg/
 
  
 
The handy thing is that plugins are autoloaded, .xml files in the phrases directory are autoloaded and .pl files in the archive cfg.d are autoloaded. So if you want to give your plugin some config options, you could just give a .pl file to copy into the cfg.d/ dir looking something like.
 
The handy thing is that plugins are autoloaded, .xml files in the phrases directory are autoloaded and .pl files in the archive cfg.d are autoloaded. So if you want to give your plugin some config options, you could just give a .pl file to copy into the cfg.d/ dir looking something like.
Line 24: Line 24:
 
  $c->{extension}->{my_cool_extension}->{option_1} = 1;
 
  $c->{extension}->{my_cool_extension}->{option_1} = 1;
 
  $c->{extension}->{my_cool_extension}->{keep_alive} = "always";
 
  $c->{extension}->{my_cool_extension}->{keep_alive} = "always";
 +
 +
And access it in your code like:
 +
 +
$option_1 = $plugin->{reposityory}->conf( "extension", "my_cool_extension", "option_1" )
  
 
etc.
 
etc.
  
 
You could use a shorter path in the $c datastructure, but try and make sure it's distinct to your extension so clashes don't happen.
 
You could use a shorter path in the $c datastructure, but try and make sure it's distinct to your extension so clashes don't happen.
 +
 +
$c->{PreviewPlus_alignment} = "vertical";
 +
 +
and then
 +
 +
$option_1 = $plugin->{reposityory}->conf( "PreviewPlus_alignment" );

Latest revision as of 10:20, 11 February 2010

An extension package is a .tgz file containing multiple files which adds a suite of functionality when unpacked in the /opt/eprint3/archives/ARCHIVE_ID/ directory.

An extension can be as simple as a plugin plus a css file or add a whole exciting suite of new features.

Things you might want to put into an eprints extension package:

  • Plugins: archives/ARCHIVE_ID/cfg/plugins/EPrints/Plugin/...
  • Themes: lib/themes/...
  • scripts: archives/ARCHIVE_ID/bin/...
  • CGI scripts: archives/ARCHIVE_ID/cgi/...
  • autocompletion scripts: archives/ARCHIVE_ID/cgi/users/lookup/...
  • phrase files for use by plugins or scripts: archives/ARCHIVE_ID/cfg/lang/.../phrases/...
  • images, icons, javascript and css files to support your plugins or scripts: archives/ARCHIVE_ID/cfg/static/...

Other things you might want to include are...

  • configuration files
  • repository specific phrase files
  • autocompletion data files

The handy thing is that plugins are autoloaded, .xml files in the phrases directory are autoloaded and .pl files in the archive cfg.d are autoloaded. So if you want to give your plugin some config options, you could just give a .pl file to copy into the cfg.d/ dir looking something like.

$c->{extension}->{my_cool_extension}->{option_1} = 1;
$c->{extension}->{my_cool_extension}->{keep_alive} = "always";

And access it in your code like:

$option_1 = $plugin->{reposityory}->conf( "extension", "my_cool_extension", "option_1" )

etc.

You could use a shorter path in the $c datastructure, but try and make sure it's distinct to your extension so clashes don't happen.

$c->{PreviewPlus_alignment} = "vertical";

and then

$option_1 = $plugin->{reposityory}->conf( "PreviewPlus_alignment" );