اعلامیه های Jdoc
From Joomla! Documentation
اعلان های jdoc در هر قالبی وجود دارد و محل خروجی دیگر قسمت های جوملا یا محلی را که افزونه ها باید در سراسر صفحه وب قرار بگیرند نشان میدهد. اعلان jdoc چیزی شبیه این است : <jdoc:include type="component" />
jdoc:include
اعلان <jdoc:include />
نمایش محتوای قالب بندی جوملا که برای نمایش صفحه معین شده است. اعلان های <jdoc:include />
متنوعی وجود دارند، که هر کدام به قسمت متفاوتی از صفحه جوملا رجوع می کنند. جایگزینی به خودی خود در JDocumentHTML::_renderTemplate انجام می شود. همچنین _parseTemplate را ببینید.
خاصیت type
خاصیت type نوع محتوایی را در جایی که عنصر <jdoc:include />
قرار گرفته است را تحویل می دهد. برای مثال عبارت <jdoc:include type="head" />
خاصیت type
که استفاده می کند head
است (type="head"
). (توجه: اعلامیه Jdoc نیازمند دابل کوتیشن دور اطراف خاصیت است ، و با تک کوتیشن کار نمی کند. فضای قبل از بستن /> هم چنین اجباری است.)
کامپوننت
<jdoc:include type="component" />
This element should only appear once in the <body> element of the Template to render the main content of the page with respect to the current page being viewed.
Head
<jdoc:include type="head" />
This element should only appear once in the <head> element of the Template to render the content of the style, script and meta elements associated with the current page.
Installation
<jdoc:include type="installation" />
This element is only used within the Joomla! Installer template for Joomla and below and is of no particular use in a Front-end or Back-end template. It's somewhat the equivalent to the 'component' type, rendering the main content of an installation step.
Message
<jdoc:include type="message" />
This element should only appear once in the <body> element of the Template to render system and error messages that occurred in the request.
CSS styles for system messages can be found in templates\system\css\system.css
Module
<jdoc:include type="module" name="breadcrumbs" title="Breadcrumbs" />
<jdoc:include type="module" name="mainmenu" title="Main Menu" />
This element renders a single module given by the name and title attributes: name should match module type (mod_breadcrumbs and mod_menu in the examples above) while title should be the module name of the desired module. The module in question must be published and accessible by the current user in order to become visible. Additional attributes can be provided to control the layout and appearance of the module, if supported.
Modules
Modules are rendered on a page using one of the following code examples. The modules are separated into different areas of a template using template positions set in the templatedetails.xml
file. Using the jdoc:include
's name="[template position name]"
attribute, the various modules in their respective positions can be called, rendered, and styled separately. Additional attributes can be provided to control the layout and appearance of modules, if supported.
Below are some examples of module statements with module positions used frequently by Joomla! theme developers.
<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" />
Note: The name="user3"
module position is normally (by default) used for the top menu.
خاصیت استایل
The optional style=""
attribute is available for the module
and modules
types of <jdoc:include />
statements. The attribute value refers to the chrome style used to wrap the output generated by the Module. If no style is provided, a value of "none
" is used by default.
Template designers may add additional chrome names as described in Applying custom module chrome.