Deklarasi JDoc

From Joomla! Documentation

This page is a translated version of the page Jdoc statements and the translation is 100% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎فارسی • ‎français • ‎Bahasa Indonesia • ‎Nederlands • ‎русский • ‎中文(台灣)‎

Deklarasi JDoc ada di setiap templat Joomla! dan ia menandakan kemana keluaran dari bagian Joomla! yang lain, atau ekstensinya, harus diposisikan di keseluruhan halaman web. Tipikal deklarasi JDoc terlihat seperti ini:

<jdoc:include type="component" />

jdoc:include

Deklarasi <jdoc:include /> adalah metode templat Joomla! yang menampilkan konten tertentu ke halaman web yang sedang dilihat. Terdapat bermacam-macam deklarasi <jdoc:include />, yang masing-masingnya mengembalikan bagian-bagian yang berbeda dari sebuah halaman. Penggantiannya sendiri dilakukan di "JDocumentHTML::_renderTemplate". lihat juga "_parseTemplate".

Atribut "type"

Atribut type menentukan jenis konten yang akan dihasilkan di elemen <jdoc:include />. Lihat contoh di bawah ini.

<jdoc:include type="head" />

Deklarasi JDoc menggunakan atribut type    head (type="head").

(Catatan: Ekspresi JDoc memerlukan kutipan ganda yang mengelilingi atribut, dan tidak akan bekerja dengan kutipan tunggal. Spasi sebelum tanda tutup /> juga wajib.)

Component

<jdoc:include type="component" />

Elemen ini harus muncul hanya satu kali di dalam <body> dari sebuah Templat, untuk menghasilkan konten utama dari halaman tergantung dari halaman yang sedang dilihat.

Head

<jdoc:include type="head" />

Elemen ini harus muncul satu kali di dalam elemen <head> dari sebuah Templat, untuk membuat gaya konten, skrip dan elemen meta yang terhubung dengan halaman yang sedang dilihat.

Installation

<jdoc:include type="installation" />

Elemen ini harus digunakan di dalam templat Pemasang Joomla! saja (untuk Joomla 2.5 dan yang sebelumnya) dan ia tidak digunakan di templat Frontend maupun Backend. Ia hampir sama dengan <type="component">, yang menghasilkan konten utama dari langkah pemasangan.

Message

<jdoc:include type="message" />

Elemen ini harus muncul satu kali di dalam elemen <body> dari sebuah Templat, untuk menghasilkan pesan sistem dan pesan galat yang muncul ketika diminta.

Gaya CSS untuk pesan sistem dapat ditemukan di templates\system\css\system.css

Module

<jdoc:include type="module" name="breadcrumbs" title="Breadcrumbs" />
<jdoc:include type="module" name="mainmenu" title="Main Menu" />

Elemen ini menghasilkan sebuah modul tunggal yang berasal dari atribut name dan title: name harus sesuai dengan jenis modulnya (mod_breadcrumbs dan mod_menu dalam contoh di atas), sementara title haruslah nama dari modul tersebut.

Module harus diterbitkan dan dapat diakses oleh pengguna agar dapat terlihat. Atribut tambahan dapat diberikan untuk mengendalikan tata letak dan tampilan module, jika didukung.

Modules

Modules dihasilkan di suatu halaman melalui salah satu contoh kode berikut ini. Modules itu terpisah antara area yang satu dengan yang lainnnya dari sebuah templat melalui aturan posisi templat di berkas templatedetails.xml. Dengan menggunakan atribut jdoc:include name="[template position name]", bermacam-macam modules dalam posisi mereka masing-masing dapat dipanggil, dan diberi gaya sendiri-sendiri. Atribut tambahan dapat diberikan untuk mengontrol tata letak dan tampilan dari modules, jika didukung.

Di bawah ini adalah contoh-contoh deklarasi modules dengan posisi modul yang digunakan berulang kali oleh para pengembang tema Joomla.

<jdoc:include type="modules" name="debug" />
<jdoc:include type="modules" name="icon" />
<jdoc:include type="modules" name="left" style="rounded" />
<jdoc:include type="modules" name="left" style="xhtml" />
<jdoc:include type="modules" name="right" style="xhtml" />
<jdoc:include type="modules" name="status"  />
<jdoc:include type="modules" name="syndicate" />
<jdoc:include type="modules" name="title" />
<jdoc:include type="modules" name="toolbar" />
<jdoc:include type="modules" name="top" />
<jdoc:include type="modules" name="top" style="xhtml" />
<jdoc:include type="modules" name="user1" style="xhtml" />
<jdoc:include type="modules" name="user2" style="xhtml" />
<jdoc:include type="modules" name="user3" />
<jdoc:include type="modules" name="user4" />

Catatan: Posisi modul name="user3" biasanya (secara standar) digunakan untuk memposisikan menu di bagian paling atas dari halaman.

Atribut "style"

Atribut opsional style="" ini tersedia untuk module dan modules, merupakan jenis dari deklarasi <jdoc:include />. Nilai atribut mengacu pada gaya chrome yang digunakan untuk membungkus keluaran hasil Modul. Jika tidak ada gaya yang diberikan, nilai "none" yang akan digunakan sebagai standar.

Para desainer templat boleh menambahkan nama-nama chrome seperti dijelaskan di Menerapkan modul chrome kustom.

Lihat juga