addons1 1en id

Bagaimana MendistribusikanMakro Anda Dengan Addon

Disediakan olehProyek Dokumentasi OpenOffice.org

How-To Proyek Dokumentasi OpenOffice.org

Daftar Isi

1 Pengenalan.......................................................................................................................41.1 Peringatan...............................................................................................................................41.2 Perubahan pada dokumen.......................................................................................................41.3 Apakah kemampuan yang dimiliki oleh sebuah Addon?.........................................................6

2 Alat bantu untuk membuat berkas XML untuk sebuah addon..........................................92.1 Pendahuluan...........................................................................................................................92.2 Membuat berkas konfigurasi..................................................................................................92.3 Mengkompresi addon.............................................................................................................92.4 Catatan mengenai informasi yang harus disediakan..............................................................10

a) Isi dari Addon....................................................................................................................10b) Catatan mengenai kerangka konfigurasi............................................................................10c) Judul..................................................................................................................................10d) Sub-menu..........................................................................................................................11e) Tombol...............................................................................................................................11f) URL...................................................................................................................................11g) Ikon...................................................................................................................................11

3 Instalasi addons..............................................................................................................143.1 Direktori instalasi.................................................................................................................143.2 Menjalankan pkgchk.............................................................................................................14

a) Instalasi addons untuk satu pemakai.................................................................................14b) Instalasi spesifik addons untuk satu pemakai....................................................................15c) Instalasi addons untuk jaringan..........................................................................................15d) Menginstall addon tertentu untuk jaringan........................................................................15e) Menghapus sebuah addon..................................................................................................15

3.3 Contoh berkas batch.............................................................................................................15

4 Daftar cek sebelum membuat addon...............................................................................17

5 Berkas XML addon.xcu.................................................................................................185.1 Lapisan tetap........................................................................................................................185.2 AddonMenu (item di dalam menu Tools).............................................................................205.3 Sub-menu.............................................................................................................................21

a) Item sub-menu...................................................................................................................21b) Pemisah antara dua item sub-menu...................................................................................21c) Membuka sub-menu sekunder...........................................................................................22

5.4 OfficeMenubar (item di dalammenu utama).........................................................................235.5 OfficeToolbar (tombol di dalam Toolbar).............................................................................24

http://id.openoffice.org 2


5.6 OfficeHelp (item dalam menu Help).....................................................................................255.7 Imej......................................................................................................................................265.8 Struktur umum dari sebuah properti....................................................................................275.9 Properti URL........................................................................................................................275.10 Properti Title Title property................................................................................................275.11 Properti ImageIdentifier.....................................................................................................28

a) Imej internal OpenOffice....................................................................................................28b) Imej yang disediakan bersam-sama dengan addon............................................................28c) Varian-varian imej..............................................................................................................29

5.12 Properti Target...................................................................................................................295.13 Properti Context.................................................................................................................295.14 Nilai properti yang spesifik untuk Images..........................................................................30

a) Properti URL dalam sebuah simpul imej...........................................................................30b) Properti imej......................................................................................................................30

6 Credits ...........................................................................................................................32

7 Licences.........................................................................................................................337.1 Documentation.....................................................................................................................337.2 Macro libraries.....................................................................................................................33



1 Pengenalan

Ketika Anda membuat makro yang menyediakan fitur baru pada OpenOffice, Anda mengaktifkannya melalui menu konfigurasi atau dengan menambahkan tombol pada balok alat bantu (tool bar). Menyisipkan makro dan mengkonfigurasikannya pada beberapa PC adalah tugas yang membosankan danmembutuhkan kehati-hatian. Ada suatu metode untuk mengotomatisasikannya dengan banyak kemampuan dan dengan memperhatikan jenis instalasi (PC yang berdiri sendiri atau di dalam jaringan). Metode ini disebut Addon. Kemampuan ini telah tersedia semenjak versi 1.1 dari OpenOffice (fungsi operasi terbatas telah tersedia pada OOo 1.0.3).

Instalasi Addon pada dasarnya tergantung pada suatu berkas XML yang mendeskripsikan konfigurasi yang akan diinstall. Berkas ini agak kompleks, bab 2 akan memberikan alat bantu sederhana (Basic tool) yang mana akan membantu Anda membuat berkas XML ini tanpa harus mengetahui strukturnya.

Bab berikutnya akan menunjukkan bagaimana menyisipkan Addon (atau memblok Addon) di dalam OpenOffice.

Bagian selebihnya dari dokumen ini diperuntukkan bagi pembaca yang penasaran: penjelasan teknis yangtelah disederhanakan mengenai struktur berkas konfigurasi XML. Informasi yang diberikan disini berasaldari versi 1.1RC4 dan dari Developer's Guide bab 4.7.3 dan 4.9.1, diperlengkapi dengan analisa beberapa Addon yang seharusnya bisa bekerja.

1.1 Peringatan

Informasi dan alat bantu yang terdapat pada dokumen ini telah dicoba dengan OpenOffice 1.1, pada PC yang berdiri sendiri memakai sistem operasi Windows XP.

Berhati-hatilah dan lakukan pemeriksaan bahwa setiap Addon yang dibuat bisa bekerja dengan benar. Lebih berhati-hatilah jika Anda bekerja pada suatu jaringan (lihat bab 3.2).

Pustaka ini didistribusikan dengan harapan bahwa pustaka ini bisa bermanfaat, tetapi TANPA SUATU JAMINAN; bahkan tanpa jaminan untuk DIPERJUALBELIKAN atau KESESUAIAN UNTUK PEMAKAIAN TERTENTU. Lihat GNU Lesser General Public licence untuk penjelasan lebih detil.

Setiap pengalaman praktis yang bisa membantu saya memperbaiki HowTo ini akan diterima dengan senang hati.

1.2 Perubahan pada dokumen

Perubahan utama sejak versi tertanggal 23 Oktober 2003

Dokumen

bab 2.4 c) ditambahkan: deskripsi judul dan tombol akselerasi (accelerator key)

bab 2.4 e) ditambahkan: deskripsi tobol dan pemisah tombol

bab 5.11 a) modifikasi



Alat bantu (revisi 1.1)

Tombol......Fasilitas untuk menambahkan pemisah

Menus........Pemisah ditambahkan, seperti pada tombol dialog



1.3 Apakah kemampuan yang dimiliki oleh sebuah Addon?

Sebuah Addon dapat melakukan integrasi satu atau beberapa fungsi kedalam menu dan balok alat bantu OpenOffice. Fungsi-fungsi ini bisa dibuat dengan berbagai bahasa pemrograman, misalnya OpenOffice Basic. Suatu Addon dapat melakukan:

Menyisipkan pustaka makro kedalam soffice (dapat diakses oleh setiap program aplikasi)

Menambahkan item menu baru didalam menu utama, di sebelah kiri menu Window. Ini sebaiknya hanya dipakai untuk fitur yang penting dan kompleks. Harap dicatat bahwa sebuah sub-menu harus dibuat untuk item ini.

Menambahkan sebuah menu di dalam menu Tools > Add-ons. Pada konfigurasi standar item Add-ons ditampilkan hanya jika setidaknya satu addon memakai fasilitas ini dan kemudian membuka satu sub-menu dengan satu item menu untuk setiap addon.

Pada saat yang sama, sebuah ikon Add-Ons muncul pada toolbar yang membuka sub-menu yang sama.



Untuk kedua kemungkinan ini,Anda boleh mendefinisikan sub-menu bertingkat dengan beberapa item menu pada setiap tingkatannya.

Untuk setiap item sub-menu:

• Anda boleh memilih untuk menampilkannya hanya pada program aplikasi tertentu, misalnya Writer dan Calc;

• Anda boleh menyediakan beberapa judul yang pemakaiannya tergantung pada bahasa lokal;

• Anda boleh menyediakan sebuah ikon untuk ditampilkan; ikon ini bisa sampai 4 varian (ikon kecil atau besar, dikombinasikan dengan kontras normal atau tinggi).

Anda boleh menambahkan satu atau beberapa tombol pada balok Functions, disini sekali lagi dengan fasilitas yang sama seperti pada konteks program aplikasi, title yang sesuai dengan bahasa, ikon yang terasosiasikan.

Akhirnya Anda dapat menambahkan sebuah item menu di dalam menu Help dengan fasilitas yang sama.



Instalasi Addon pada OpenOffice

Memang dimungkinkan untuk menginstal sebuah addon dengan cara yang relatif lebih sederhana pada sebuah PC (berdiri sendiri atau bagian dari jaringan OpenOffice) atau dengan cara tersentralisir pada jaringan OpenOffice.

Mekanisme addon membuat update lebih sederhana. Versi terinstal akan digantikan oleh versi baru ketika Anda mengulangi prosedur instalasi.

Tentu saja alat bantu instalasi dapat juga memblok suatu addon.



2 Alat bantu untuk membuat berkas XML untuk sebuah addon

Alat bantu ini adalah satu set makro didalam HowTo ini. Meskipun dapat dipakai untuk menciptakan berbagai macam tipe addon, saya hanya memfokuskan pada bagaimana untuk mengintegrasikan makro.

2.1 Pendahuluan

Kita ambil contoh bahwa makro Anda dikumpulkan didalam pustaka makro soffice yang diberi nama TATA. Pustaka ini terdapat pada PC yang Anda pakai untuk melakukan tes makro. Anda akan menemukannya di direktori {installation}/user/basic/TATA/

Di dalam direktori kosong (contoh: Work/), Anda mengkopikan direktori yang berisi pustaka Anda. Sekarang Anda mendapatkan direktori Work/TATA/

Jika Anda mendapatkan berkas imej untuk item menu atau tombol nantinya, buatlah sebuah penggandaannya di dalam direktori Work/TATA/atau sebaiknya di beberapa sub direktori dibawahnya.

Dengan memakai Organizer untuk makro, hapuslah pustaka TATA dari PC Anda. Nanti Anda dapat menambahkannya dari salinan Anda.

Anda harus sudah bisa menentukan item menu mana yang akan dibuat berikut judul-judulnya.

Anda seharusnya tahu jika Anda hendak menyediakan tombol dengan ikon dalam fungsi Toolbar dan jika Anda ingin menyediakan ikon untuk item menu yang lainnya.

Anda telah menyiapkan daftar untuk meyakinkan tidak ada yang terlupakan. Anda bisa melihat di bab 4 mengenai contoh daftar tersebut.

2.2 Membuat berkas konfigurasi

Klik tombol di sebelah kanan dan jawablah pertanyaan dengan hati-hati karenasangat mungkin Anda akan membuat kesalahan. Beberapa kali mencoba akanmembantu Anda memahami alat bantu ini. Bab 24 menawarkan beberapapenjelasan.

Dalam kebanyakan panel yang ditampilkan, ada jendela teks di bagian atasnya yang menampilkan catatandari aksi yang telah dijalankan selama ini. Gunakan balok geser (scrollbar) vertikal atau Ctrl-End untuk melihat tindakan yang terakhir.

Pada akhir setiap eksekusi, catatan tersebut akan ditampilkan di sebuah jendela yang besar. Bacalah dengan teliti (kesalahan ejaan, kekurangan dan kesalahan yang lain). Jika semuanya sudah benar, klik tombol 'Addon zipping' di panel. Jika Anda merasa kurang puas dengan hasilnya, Anda bisa memulainya dari awal lagi atau Anda bisa mencoba mengubah addon.xcu secara manual yang bisa dilakukan melalui text editor. Berkas addon.xcu dan Log.txt tersimpan dalam direktori Work/. Anda tidak diharuskan untuk membuat berkas zip sekarang.

Bab 5 menjelaskan deskripsi umum dari struktur berkas addon.xcu. Jika Anda menginginkan untuk memahami lebih dalam kode ini, Anda harus membaca bab 4.7.3 dari Developer's Guide.

2.3 Mengkompresi addon

Jika Anda telah puas dengan berkas addon.xcu Anda, sekarang Anda bisa membuat berkas zip yang berisi addon. Cara melakukannya adalah dengan mengklik tombol "Addon zipping" dalam panel akhir


Create XML file


atau memulai lagi alat bantu dengan mengklik tombol dibawah ini.

Dengan mengikuti contoh ini Anda akan mendapatkan TATA.zip di direktory Work/.

Bacalah bab "Menginstall addons" sekarang.

2.4 Catatan mengenai informasi yang harus disediakan

a) Isi dari Addon

Anda bisa membuat item menu atau tombol atau bahkan tidak sama sekali.

Anda bisa mendesain sebuah addon tanpa item menu sama sekali, tanpa tombol dan tanpa help: pustaka makro akan diinstall dan tersedia di soffice.

Anda bisa mendesain addon dimana beberapa tombol atau item menu mengaktifkan makro dari pustaka yang telah terinstal.

b) Catatan mengenai kerangka konfigurasi

Data konfigurasi OpenOffice disimpan dalam direktori software. Didalam direktori tertentu tersebut Anda akan menemukan semua informasi yang dibutuhkan untuk mengkonfigurasi OpenOffice. Sebuah simpul ditandai oleh namanya. Adalah suatu keharusan bahwa setiap domain konfigurasi memiliki nama khusus untuk menghindari konflik dengan domain lain yang sudah ada. Secara khusus Anda harus mengikuti aturan tersebut untuk setiap addon.

Salah satu cara yang disarankan untuk meyakinkan nama yang unik adalah memakai struktur "nama yangterkualifikasi" yang terbentuk dari kondisi dengan dipisahkan oleh titik, contohnya:

org.openoffice.Office.addon.BernardMarcelly.function1

Dengan memilih cara ini saya berharap saya adalah satu-satunya orang yang memakai cabang BernardMarcelly. Jika saya nantinya membuat addon yang lain, saya bisa memakai cabang BernardMarcelly dan menambahkan cabang beru bernama:

org.openoffice.Office.addon.BernardMarcelly.anotherfunction

Catatan

Nama dari suatu simpul adalah internal OpenOffice dan tidak akan nampak oleh pemakai addon.

Disarankan untuk memakai karakter normal (tanpa tanda aksen), angka, titik dan tidak memakai spasi.

c) Judul

Teks dari menu bisa memiliki tombol pemercepat/accelerator key (karakter muncul dengan garis bawah).Untuk memilih karakternya, tambahkan ~ sebelum karakter tersebut.

Anda dapat mendefinisikan teks untuk berbagai macam bahasa tetapi jika makro Anda menampilkan teks, Anda harus memasukkan proses translasi dalam kode Anda.


Addon zipping


d) Sub-menu

Ketika di item menu Anda ingin membuka level kedua (sebuah sub menu), pilihlah panel URL pada pilihan "URL opening a sub-menu".

Anda tidak bisa menampilkan sebuah ikon di item menu yang membuka sebuah sub-menu.

Jika Anda menambahkan sesuatu di menu utama, Anda harus membuka sebuah sub-menu.

Anda bisa membuka sampai 4 level sub menu yang berurutan tetapi sebaiknya Anda mencoba untuk lebihmeyederhanakannya.

e) Tombol

Sebuah separator tombol akan ditambahkan secara otomatis sebelum tombol pertama dari Addon. Anda juga bisa menambahkan separator di antara tombol-tombol addon.

f) URL

Anda boleh menjalankan makro yang sudah terinstal, tidak hanya makro-makro addon.

Dengan perintah dispatch Anda bisa menjalankan perintah-perintah yang lain.

Sepertinya "display mode" tidak mengubah apapun. Anda bisa membiarkan tetap seperti itu.

g) Ikon

Penggunaan ikon oleh OpenOffice

Ketika Anda mengalokasikan sebuah gambar ke item menu atau tombol, OpenOffice akan mengingat URL yang bersangkutan. Ketika Anda menggunakan URL yang sama untuk tombol yang lain atau menu yang lain, gambar yang sama akan secara otomatis dialokasikan kepadanya.

Perilaku ini sungguh logis karena URL-lah yang menjalankan aksi bukanna tombol atau item menu. Umumnya Anda akan memiliki item menu yang mengacu ke sebuah URL dan sebuah tombol mengacu ke URL yang sama. Karena Anda menyediakan dua cara untuk menjalankn suatu aksi: Anda akan memunculkan gambarnya cukup hanya sekali.

Kebalikannya jika Anda menginginkan dua gambar yang berbeda untuk dua item menu yang mengacu kepada makro yang sama, pastikan untuk tidak menampilkan URL yang sama, hal ini bisa dilakukan dengan memanggil makro dummy yang hanya memanggil makro utama atau memanggil makro yang sama tetapi dari dua modul yang berbeda (dalam Basic, makro dari suatu modul dapat diakses dari modul mana saja dari pustaka yang sama).

Struktur

Ikon yang boleh ditampilkan pada item menu atau tombol adalah "bitmap Windows" dengan ekstensi bmp. Tolong diperhatikan bahwa berkas tersebut bukanlah berkas .ico.

OpenOffice bisa memakai 4 macam varian imej:

1. ikon kecil berukuran 16x16 piksel

2. ikon besar berukuran 26x26 piksel



3. ikon kecil berukuran 16x16 piksel dengan kontras tinggi

4. ikon besar berukuran 26x26 piksel dengan kontras tinggi

Menurut dokumentasi resmi, ketika tidak ada gambar dengan kontras tinggi, OpenOffice memakai gambar dengan kontras normal (informasi ini belum diverifikasi).

Agar OpenOffice bisa menampilkan gambar dengan ukuran 16x16 piksel, Anda harus menyediakan gambarnya dan menyatakan bahwa gambar itu memang 16x16 piksel. Dengan cara yang sama, agar OpenOffice dapat menampilkan gambar 26x26 piksel (dipakai dengan opsi: ikon besar)Anda harus menyediakan gambar yang lain dan menyatakannya 26x26. Jika gambar yang Anda miliki tidak mengindikasikan ukuran, ukurannya akan diubah sebelum ditampilkan. Tetapi hasilnya lebih jelek dibandingkan dengan gambar yang khusus dibuat sesuai formatnya.

Warna RGB (255, 0, 255) menunjukkan piksel yang transparan; warna latar belakang justru yang akan ditampilkan.

Ada beberapa cara untuk membuat addon dengan ikon pada sebuah menu atau tombol. Alat bantu yang ada bisa digunakan untuk gambar tipe 1 atau tipe 2.

Gambar tipe 1

Gambar-gambar berikut harus ada di direktori addon atau di sebuah sub direktori.

Nama-nama berkas memiliki aturan yang sama diikuti dengan akhiran yang menunjukkan varian gambar.

Ukuran dalampiksel

Kontras Akhiran Contoh berkas gambar

16x16 normal _16.bmp iconExecute_16.bmp

16x16 high _16h.bmp iconExecute_16h.bmp



Anda hanya perlu untuk mengindikasikan satu dari gambar berikut dan OpenOffice akan mengambil varian yang lain dari direktori yang sama. Gambar dari tipe 1 lebih disukai karena lebih mudah ditangani.

Gambar tipe 2

Gambar-gambar ini bisa memiliki nama apa saja. Anda bisa menyediakannya:

i. sebagai suatu berkas di direktori addon atau sub direktori

ii. atau sebagai bentuk biner terkodekan dalam heksadesimal di berkas addon.xcu; dalam hal ini berkas aslinya bisa disimpan dimana saja karena tidak akan disediakan bersama dengan addon.

Berbeda dengan gambar tipe 1 Anda harus mengindikasikan sebuah berkas untuk setiap varian. Anda bisa menggabungkan gambar i) dan gambar ii).

Berkas addon.xcu menjadi lebih kompleks dengan gambar tipe 2. Dan menjadi menjadi sangat besar jika bermacam gambar tipe 2 ii) didefinisikan didalamnya.



3 Instalasi addons

OpenOffice dapat diinstal:

1. pada sebuah PC

2. pada jaringan dengan server sebagai intinya dan klien ringan pada setiap PC.Dalam hal ini Anda bisa menginstal addon

a) untuk pemakai tertentu,

b) untuk semua pemakai OpenOffice.

3.1 Direktori instalasi

Alat bantu dengan baris perintah: pkgchk dipakai untuk menginstal addons. Ia bisa menginstal:

1. addon spesifik yang diindikasikan dalam baris perintah

2. atau semua addons yang ditemukan dalam direktori standar. Ada dua direktori standar:

a) Untuk addons yang spesifik pada satu pemakai, direktorinya adalah{installation}/user/uno_packagesyang jika untuk Windows XPC:\Program Files\OpenOffice.org1.1\user\uno_packages

b) Untuk sistem jaringan direktorinya adalah{installation}/share/uno_packages

Alat bantu pkgchk ada di direktori:{installation}/program

Untuk Windows XP instalasi lokal C:\Program Files\OpenOffice.org1.1\program

3.2 Menjalankan pkgchk

Anda harus bekerja dengan baris perintah untuk menjalankan pkgchk. Disarankan untuk menyiapkan berkas batch (MS-Windows) atau skrip shell (Unix).

Direktorinya harus {installation}/program

Merupakan suatu keharusan untuk menghentikan semua proses yng berhubungan dengan OpenOffice sebelum menjalankan pkgchk. Anda juga harus menghentikan QuickStarter OpenOffice (versi MS-Windows). Untuk jaringan semua OpenOffice harus dihentikan. Tanpa persiapan ini, instalasi OpenOffice bisa rusak. Pkgchk bisa melakukan tes untuk melihat apakah OpenOffice dijalankan secara lokal tetapi tidak bisa mendeteksi hal ini pada instalasi untuk jaringan.

a) Instalasi addons untuk satu pemakai

Letakkan addons di direktori {installation}/user/uno_packages

Jalankan perintah sederhana berikut:



pkgchk

Atau jika Anda ingin menampilkan laporan semasa eksekusi, tambahkan opsi -v:

pkgchk -v

b) Instalasi spesifik addons untuk satu pemakai

Letakkan addon zip file di sebuah direktori. Sebagai parameter untuk perintahnya, berikan path ke berkas addon. Contoh untuk MS-Windows:

pkgchk C:\tests\MyOwnAddon.zip

Masih untuk Windows, jika ada spasi di dalam path atau nama berkas, Anda harus mengakhiri path dengan tanda petik seperti ini:

pkgchk "C:\My Documents\MyOwnAddon.zip"

c) Instalasi addons untuk jaringan

Letakkan addon ke {installation}/share/uno_packages

Jalankan perintah:

pkgchk --shared

d) Menginstall addon tertentu untuk jaringan

Letakkan berkas zip addon di dalam suatu direktori. Sebagai argumen untuk perintah, berikan path ke berkas addon. Contoh untuk MS-Windows:

pkgchk --shared C:\tests\MyOwnAddon.zip

e) Menghapus sebuah addon

Blok addon ini dari direktori standar. Perlu dicatat bahwa jika Anda menginstal addon memakai metode b) atau d) Anda akan menemukan addon itu di direktori standar (default directory).

Jalankan perintah a) atau c)

Penjelasan: pkgchk akan memperbarui semua addon berdasarkan isi direktori standar. Addon yang tidak ada lagi akan diblok.

3.3 Contoh berkas batch

Ini adalah contoh sederhana batch untuk Windows XP yang menginstal addon tertentu pada komputer yang menjalankan batch ini. Urutan copy ... packages\" harus berada di baris yang sama.

@echo offecho WARNING : stop completely OpenOffice, including the QuickStarter !! **echo hit a key when it is donepausecopy C:\Work\TestAddon.zip "C:\Program Files\OpenOffice.org1.1.0\user\ uno_packages\"pausec:cd "c:\Program Files"



cd "OpenOffice.org1.1.0\Program"pkgchk -vpause



4 Daftar cek sebelum membuat addon

Untuk addon yang kompleks sangatlah dianjurkan untuk memiliki jawaban sebelum menjalankan pembuatan makro.

Pilih sebuah nama yang unik yang spesifik untuk addon Anda. Nama itu tidak boleh sama dengan nama addon yang lain yang pernah ditulis oleh Anda atau orang lain.

Periksa kembali setiap fitur dasar berikut:

1. item di menu utama, sub-menu

2. item di menu Tools, sub-menu

3. tombol di Function Toolbar

4. item di menu Help item in the Help menu

Tentukan judul untuk item menu, nama dari makro dan gambar yang terkait.

Jika addon Anda hanya muncul pada konteks tertentu, pilihlah konteks mana yang diinginkan untuk setiap item menu dan setiap tombol.

Untuk setiap judul, Anda boleh menyiapkan terjemahan dalam berbagai bahasa.

Untuk setiap gambar yang terkait Anda harus memilih apakah gambar tersebut akan disediakan dalam bentuk berkas (file) dalam addon dan memutuskan nama berkas, atau mengintegrasikannya dalam berkasxml. Setiap gambar yang terkait dapat dilengkapi dengan beberapa varian, dan ini juga harus dipersiapkan sebelumnya.

Setelah menjalankan alat bantu jika Anda membuat kesalahan, Anda dapat mencetak berkas log dan mencatat mana yang seharusnya berbeda. Catatan ini dapat dipakai sebagai daftar cek untuk Anda saat menjalankan lagi alat bantu tersebut.



5 Berkas XML addon.xcu

Berkas addon.xcu adalah berkas teks dalam sintaks XML yang menjelaskan bagaimana untuk mengintegrasikan addon ke OpenOffice. Untuk informasi lebih lanjut mengenai XML Anda dapat membaca buku: Learning XML yang diterbitkan oleh O'Reilly & Associates.

Tujuan dari bab ini adalah untuk membantu Anda membaca dan mungkin mengubah berkas ini.

Berkas ini memakai tags yang memiliki arti dan sintaks untuk pemakaiannya.

Berkas ini terstruktur dalam "Russian dolls". Penjelasannya memakai konsep kaskade.

Setiap element yang terdaftar tersusun dari tag pembuka, isi dan tag penutup, seperti halnya dokumen HTML misalnya.

5.1 Lapisan tetap

Tiga lapisan yang pertama adalah teks tetap sebagai deskripsi addon.

Lapisan "User Interface Addon" berisi satu atau lebih komponen. Sketsa diatas menunjukkan 5 komponen yang mungkin. Urutan komponen tidaklah penting, setiap komponen hanya bisa muncul sekali saja. Kita akan mempelajari setiap komponen. Tetapi sebelumnya, kita akan membicarakan prinsip dari penyimpanan konfigurasi di OpenOffice.

Data konfigurasi OpenOffice disimpan dalam struktur direktori software. Di dalam simpul (node) tertentu di direktori tersebut Anda bisa mendapatkan semua informasi yang diperlukan untuk melakukan konfigurasi bagian-bagian dari OpenOffice. Suatu simpul diidentifikasikan oleh namanya. Adalah suatu keharusan bahwa setiap domain konfigurasi memiliki nama yang khusus untuk menghindari konflik dengan simpul lain yang yang telah ada dalam konfigurasi. Secara umum Anda harus mematuhi aturan iniuntuk setiap addon yang Anda buat.

Kualifikasi nama yang sama dapat dipakai untuk menamai komponen yang lain dari addon dikarenakan setiap komponen (Office Menubar, OfficeToolbar, dll) adalah simpul yang teratas. Sebagai kasus yang khusus gambar komponen terbuat dari banyak sub komponen gambar untuk disisipkan. Sub komponen


File encoding

Addon register

User Interface Addon

OfficeMenubar

OfficeToolbar

AddonMenu

OfficeHelp

Images


ini akan dibedakan dengan menambahkan kualifikasi seperti:

org.openoffice.Office.addon.BernardMarcelly.fonction1.img02



5.2 AddonMenu (item di dalam menu Tools)

AddonMenu mendefinisikan sebuah menu dalam Tools > Addons. Menu ini terdiri dari sebuah amplop untuk memberikan nama yang tidak membingungkan dalam struktur konfigurasi ( configuration tree )dari OpenOffice. Amplop ini berisi beberapa properti - yang akan dijelaskan nanti - dimana urutannya tidaklah terlalu penting.

Sub-menu adalah elemen komposit yang bisa ada atau tidak. Sub-menu dipakai untuk mendefiniskan level yang lebih dalam di suatu menu. Strukturnya akan dijelaskan pada bab berikutnya.

Perlu dicatat bahwa jika sub-menu ada, URL dari properti ini dapat dihilangkan atau boleh berisi apa sajakrena tidak akan ada makro yang diaktifkan. Properti ImageIdentifier juga bisa dihilangkan karena akan diabaikan dan tidak ada imej yang akan ditampilkan.


AddonMenuUnique Node

Property : URL

Property : ImageIdentifier

Property : Title

Property : ContextProperty : Target

SubmenuItem : unique internal node

Item : unique internal node

etc...


5.3 Sub-menu

Sebuah sub-menu mendefinisikan item sub-menu. Sub-menu dibentuk dari satu atau lebih item.

Setiap item dibentuk dari suatu amplop yang dipakai untuk menamai konfigurasi ini secara tak ambigu didalam sub-menu. Alat bantu akan menentukan nama yang unik untuk simpul ini. Isi dari suatu item memiliki tiga varian.

a) Item sub-menu

Ini adalah kasus yang palim umum. Urutan properti tidaklah penting.

b) Pemisah antara dua item sub-menu.



Property : URL


Property : Title



Property : URL (separator)


c) Membuka sub-menu sekunder

Anda mengenali struktur ini dari bab sebelumnya – ini merupakan definisi berulang (rekursif). Alat bantu ini memiliki batasan hanya untuk 4 level – yang seharusnya sudah cukup memadai.



Property : URL


Property : Title


SubmenuItem : unique internal node


etc...


5.4 OfficeMenubar (item di dalammenu utama)

OfficeMenuBar mendefinisikan sebuah item menu pada level tertinggi di sebelah kiri item Window. Item menu tersebut terdiri dari sebuah amplop yang dipakai untuk menamai konfigurasi ini secara tak ambigu di dalam struktur konfigurasi ( configuration tree ) dari OpenOffice. Amplop ini berisi dua properti – akan dijelaskan nanti – dan elemen komposit yang disebut Submenu, seperti dijelaskan sebelumnya. Urutan dari properti ini tidaklah penting. Perlu dicatat bahwa untuk OfficeMenubar, sub-menu adalah suatu keharusan karena ini adalah cara satu-satunya untuk menjalankan sebuah makro.


OfficeMenubarUnique node

Property : Title

Property : Context

Submenu



etc...


5.5 OfficeToolbar (tombol di dalam Toolbar)

OfficeToolbar mendefinisikan satu atau lebih tombol di dalam Fungsi Toolbar (ini adalah toolbar dengan tombol-tombolnya: Open file, Save Document).

Tombol ini terdiri dari amplop yang digunakan untuk menamai strukture konfigurasi ini secara tak ambigu dalam struktur konfigurasi dari OpenOffice. Dalam amplop ini Anda akan menemukan satu atau lebih pendeskripsi tombol. Setiap pendeskripsi dibentuk dari sebuah amplop untuk menamai tombol ini secara tak ambigu di simpul tertinggi. Alat bantu akan menentukan nama yang unik untuk simpul ini.

Dalam setiap amplop dari tombol Anda akan menemukan beberapa properti. Urutan properti ini tidaklah penting.


OfficeToolbarUnique node

Button : unique internal node


etc...


Property : URL


Property : Title



5.6 OfficeHelp (item dalam menu Help)

OfficeHelp mendefinisikan item help yang akan disisipkan dalam menu Help, setelh item "Registration...". Menu ini terbuat dari sebuah amplop yang dipakai untuk menamai konfigurasi ini secara tak ambigu dalam struktur konfigurasi dari OpenOffice.

Dalam amplop ini Anda akan menemukan beberapa properti. Urutan properti tersebut tidaklah penting.


OfficeHelpUnique node

Property : URL


Property : Title



5.7 Imej

Images mendefinisikan satu atau lebih imej bertipe 2 (dalam kasus kita, ini adalah ikon) dengan memberikan daftar konten binarinya. Imej komponen tidak akan ada jika semua imej adalah bertipe 1 atau jika tidak ada imej.

Amplop imej adalah tetap dan berisi satu atau lebih pendeskripsi imej. Setiap deskriptor tersusun dari sebuah amplop yang dipakai untuk menamai imej ini secara tak ambigu dalam struktur konfigurasi dari OpenOffice. Alat bantu akan menentukan nama unik untuk simpul ini.

Setiap simpul imej berisi URL properti dan sebuah simpul internal dipakai sebagai penampung untuk beberapa varian dari imej yang sama. Terdapat sampai 4 varian.

Properti-properti ini adalah spesifik untuk setiap imej. Hal ini akan dijelaskan nanti.


Images

Image : unique internal node


etc...


Property : URL

UserDefinedImages node

Property : image, variant 1

Property : image, variant 2

1 to 4 variants


5.8 Struktur umum dari sebuah properti

Sebuah properti dimulai dengan tag <prop...> dan diakhiri dengan tag </prop>

Tag pembuka berisi nama properti. Nama itu juga mengindikasikan nilai properti berupa tipe "String".

Di antara dua tag terletak nilai properti. Nilai tersebut bisa muncul dalam beberapa aspek:

<value/>

artinya: tidak berisi nilai

<value>blabla blabla etc</value>

string di antara dua "value" dikodekan dengan Unicode UTF-8 sehingga karakter beraksen atau bernasionalsasi akan dikonversi menjadi beberapa karakter.

karakter tanda petik, tanda petik ganda, komersial dan tanda lebih kecil, lebih besar akan dituliskan dalam bentuk entiti karakter yang telah didefinisikan sebelumnya, sebagai contoh:< menjadi &lt.

Cara lain untuk mendeskripsikan bagaimana sebuah nilai dipakai tergantung pada propertinya.

5.9 Properti URL

Pada umumnya sebuah URL dipakai untuk menjalankan sebuah makro ketika seuah item menu atau tombol Fungsi Toolbar diaktifkan. Nilai untuk URL dituliskan seperti ini:

<value>macro:///MyLib.Module1.Function1</value>

Pada contoh diatas makro yang dijalankan adalah Function1 dan disimpan dalam modul Module1 dari pustaka MyLib.

Anda mendeklarasikan sebuah pembatas menu atau pembatas tombol dengan nilai konvensional:

<value>private:separator</value>

5.10 Properti Title Title property

Ini adalah teks yang dapat dilihat pada antarmuka pemakai, contohnya teks dari sebuahmenu.

Anda dapat menspesifikasikan bahasa yang bersifat lokal yang dapat diaplikasikan pada teks ini. Contoh:

<value>erase</value><value xml:lang="en-UK">rub out</value><value xml:lang="fr">gommer</value>

Baris pertama berlaku jika bahasa yang dipakai secara lokal adalah bukan salah satu dari bahasa yang telah disediakan.

Baris yang kedua berlaku untuk bahasa Inggris ala United Kingdom.

Baris ketiga berlaku untuk bahasa Perancis bergantung pada negaranya (Perancis, Canada, Belgia, Swiss...).

Berikut ini adalah beberapa kombinasi umum dari bahasa-negara:



Bahasa-Negara Idiom

en-US Bahasa Inggris ala Amerika

en-GB Bahasa Inggris ala Inggris

fr-FR Bahasa Perancis ala Perancis

de-DE Bahasa Jerman ala Jerman

it-IT Bahasa Itali

es-ES Bahasa Spanyol

pt-PT Bahasa Portugis ala Portugis

nl-NL Bahasa Belanda

da-DK Bahasa Denmark

sv-SE Bahasa Swedia

hu-HU Bahasa Hongaria

Kode Bahasa dengan 2 karakter adalah ternomalisasi (ISO 639), Anda akan menemukan daftar pada beberapa halaman web seperti daftar inggris (english list)ini.

Kode Negara dengan 2 karakter juga ternomalissi (ISO 3166), Anda akan menemukan sebuah daftar pada berbagai halaman web seperti daftar inggris ( english list) ini.

5.11 Properti ImageIdentifier

Isi dari ImageIdentifier adalah alamat URL dari sebuah imej yang akan diasosiasikan dengan komponen tersebut.

Imej tersebut bisa jadi merupakan sebuah sumber internal dari OpenOffice atau suatu berkas yang dilengkapi dengan addon.

a) Imej internal OpenOffice

Imej tipe ini tidak didukung oleh alat bantu makro dalam dokumen ini.

Nilai ImageIdentifier ditulis seperti ini:

<value>private:image/1</value>

/1 menspesifikasikan imej internal nomor 1 adalah imej yang digunakan.

Saya tidak berhasil membuatnya bekerja.

b) Imej yang disediakan bersam-sama dengan addon

Nilai untuk ImageIdentifier dituliskan seperti ini:

<value>%origin%/TATA/titi/iconExecute</value>

Dalam contoh ini direktori utama adalah TATA/ dan berkas imej tersimpan di direktori /titi/.

Nama %origin% berarti path ke direktori TATA/


http://www.oasis-open.org/cover/country3166.html

http://www.oasis-open.org/cover/country3166.html


Mengapa ada beberapa imej? Karena adanya varian-varian imej...

c) Varian-varian imej

OpenOffice mengendalikan 4 tipe imej. Hanya bagian kiri yang umum saja yang dispesifikasikan dalam URL. Nama lengkap berkas untuk setiap tipe didapatkan dari nama yang disediakan dengan menmbahkan akhiran.

Ukuran (piksel) Kontras Akhiran Contoh berkas imej





Sebagai konsekuensi dari aturan ini, nama berkasimej harus memakai akhiran yang diijinkan, khususnya dengan ekstensi " .bmp".

5.12 Properti Target

Nilai untuk Target berupa salah satu dari empat katakunci berikut:

_top _parent _self _blank

Satu-satunya pemakaian yang saya pernah lihat adalah _self:

<value>_self</value>

5.13 Properti Context

Context menspesifikasikan bahwa komponen tersebut akan tersedia hanya di satu atau beberapa aplikasi OpenOffice. Suatu nilai kosong berarti komponen tersebut teredia untuk semua aplikasi.

Aplikasi Nama servisnya

Writer com.sun.star.text.TextDocument

Calc com.sun.star.sheet.SpreadsheetDocument

Impress com.sun.star.presentation.PresentationDocument

Draw com.sun.star.drawing.DrawingDocument

Formula com.sun.star.formula.FormulaProperties

Diagram (Chart) com.sun.star.chart.ChartDocument

Bibliography Database com.sun.star.frame.Bibliography

Contoh 1

<value>com.sun.star.drawing.DrawingDocument</value>



Contoh 2

Disini komponen tersebut tersedia untuk dua program aplikasi:

<value>com.sun.star.drawing.DrawingDocument,com.sun.star.presentation.PresentationDocument</value>

Contoh 3

Disini komponen tersedia untuk setiap program aplikasi:

<value/>

5.14 Nilai properti yang spesifik untuk Images

Komponen Images dipakai untuk menspesfikasikan imej yang tidak dispesifikasikan oleh properti ImageIdentfier seperti telah dijelaskan diatas.

Komponen Images memakai nilai yang spesifik untuk propertinya.

a) Properti URL dalam sebuah simpul imej

Nilai untuk URL adalah string yang sama dengan yang dipakai untuk URL dari komponen yang membutuhkannya. Sebagai contoh sebuah komponen AddonMenu mengaktifkan sebuah makro pada item menu; URL dari simpul imej akan memakai kembali urutan pemanggilan makro yang sama.

Ketika menemui sebuah komponen dengan ImageIdentifier yang kosong, OpenOffice akan memindai setiap simpul imej untuk mencari URL yang identik. Jika ditemukan, imej ini akan diasosiasikan ke item menu.

b) Properti imej

Ada 8 varian dari properti ini karena OpenOffice dapat mengendalikan 4 varian imej, entah terintegrasi dalam berkas XML atau dispesifikasikan sebagai berkas imej yang disediakan oleh addon.

Ukuran (piksel) Kontras Nama Properti

Iimej terintegrasi Imej yang disediakan

16x16 normal ImageSmall ImageSmallURL

16x16 high ImageSmallHC ImageSmallHCURL

26x26 normal ImageBig ImageBigURL

26x26 high ImageBigHC ImageBigHCURL

Nilai untuk sebuah imej yang terintegrasi dalam berkas XML

Nilai parameter tersebut adalah nilai binari (tak terkompresi) dari imej tersebut, tertulis dalam teks heksadesimal contoh untuk imej 16x16:

<value>424df80000000000000076000000280000001000000010000000010004000000000000000000120b0000120b000000000000000000000000ff0000ffff0000ff0000ffff0000ff000000ff00ff00ffffff00c0c0c000808080000000000000008000008080000080000080800000800000008000800055555555555555555665565555556556556656555655656655566656565566655666668666586655555586686



556666655555566556685555566655656686655555556555556655555566866565566655555866556655555566666556866855555566856668666665566655656566655566565565556566556556555555655660000</value>

Perlu dicatat bahwa untuk jumlah piksel yang sama, dua berkas bmp akan memiliki ukuran yang berbedajika imejnya dikodekan dengan kedalaman warna yang berbeda (16 warna, 16 juta warna, dst).

Nilai untuk sebuah imej yang disediakan dalam addn

Nilainya dituliskan seperti ini:

<value>%origin%/TATA/titi/iconExecute.bmp</value>

Dalam contoh ini berkas Anda *.xlb *.xdl dan *.xba dikelompokkan dalam sebuah direktori, misalnya TATA/ dan berkas imej disimpan dalam sub-direktori /titi/

Nama %origin% berarti path ke direktori TATA/



6 Credits

Pengarang: Bernard Marcelly

Terima kasih kepada: Laurent Godard untuk tip dan bantuannya, khususnya mengenai addon zipping.

Diintegrasikan oleh:

Modifikasi terakhir: November, 19, 2003 January 2007 (Bahasa Indonesia)

Kontak: OpenOffice.org Documentation project http://fr.openoffice.org

Penerjemahan: Bernard Marcelly - November, 18, 2003 (Inggris) Chrismastanto – Januari 2007 (Indonesia)


http://fr.openoffice.org/


7 Licences

7.1 Documentation

Appendix

Public Documentation License Notice

The contents of this Documentation are subject to the Public Documentation License Version 1.0 (the "License"); you may only use this Documentation if you comply with the terms of this License. A copy of the License is available at http://www.openoffice.org/licenses/PDL.html. The Original Documentation is : Commentdiffuser vos macros avec un AddonThe Initial Writer of the Original Documentation is Bernard MarcellyCopyright (C) 2003. All Rights Reserved. (Initial Writer contact(s): marcelly@clubinternet.fr )

Contributor(s): ______________________________________. Portions created by ______ are Copyright (C)_________[Insert year(s)]. All Rights Reserved. (Contributor contact(s):________________[Insert hyperlink/alias]).

NOTE: The text of this Appendix may differ slightly from the text of the notices in the files of the Original Documentation. You should use the text of this Appendix rather than the text found in the Original Documentation for Your Modifications.

7.2 Macro libraries

General information on LGPL is available on this Web site.

The standard library included in this document is a tool which produces files for an OpenOffice.org Add-on. Copyright (C) 2003 Bernard Marcelly

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


mailto:[email protected]

http://www.gnu.org/copyleft/lesser.html

mailto:[email protected]

http://www.openoffice.org/licenses/PDL.html