Skinning.documents: Difference between revisions

From Shareaza Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
Line 1: Line 1:
{{do not translate}}
{{Language}}
{{Recovered|The following content has been recovered from the old wiki and pantheraproject*net. Competent verification is needed.}}  
{{Updated|2014.05.07| 2.7.x.0}}  


<h1> <span class="mw-headline">&lt;documents&gt;</span></h1>
=<documents>=
<p>The <b>&lt;documents&gt;</b> element provides RichDoc documents that are used within the user interface. At the current time only one Richdoc is used on the Home tab.
</p><p>RichDoc documents are not HTML, but have some distant similarities. Rather than being a text-parsed language, it is focused on being programmatic so that it may be efficiently updated in real-time without reparsing. It is also very focused, and contains only the basic functionality required to meet its intended purpose (thus eliminating the unnecessary bulk of a full HTML browser).
</p><p>The RichDoc namespace has not been fully documented yet, but here is a rough guide:
</p>
<table border="1" cellspacing="0" cellpadding="5">


<tr style="background-color:#FFFFC0;">
The '''<documents>''' element provides '''RichDoc''' documents that are used within the user interface. At the current time only one Richdoc is used on the '''Home tab'''.
<td><b>Element</b>
 
</td><td><b>Description</b>
'''RichDoc''' documents are not HTML, but have some distant similarities. Rather than being a text-parsed language, it is focused on being programmatic so that it may be efficiently updated in real-time without reparsing. It is also very focused, and contains only the basic functionality required to meet its intended purpose (thus eliminating the unnecessary bulk of a full HTML browser).
</td></tr>
 
<tr>
 
<td>&lt;document&gt;
The RichDoc namespace has not been fully documented yet, but here is a rough guide:
</td><td>The root document element. Several attribute are available, such as crBackground, crText, etc.
 
</td></tr>
 
<tr>
{| border="0" cellspacing="0" cellpadding="5"
<td>&lt;text&gt;
|- style="background-color:#FFFFC0"
</td><td>Creates a text element
|'''Elements'''
</td></tr>
|'''Description'''
<tr>
|-
<td>&lt;link&gt;
|<document>
</td><td>Creates a hyperlink element, with a target attribute.
|The root document element. Several attribute are available, such as crBackground, crText, etc.
</td></tr>
|-
<tr>
|<text>
<td>&lt;heading&gt;
|Creates a text element
</td><td>Creates a heading element, in the document's heading style.
|-
</td></tr>
|<link>
<tr>
|Creates a hyperlink element, with a '''target''' attribute.
<td>&lt;bitmap&gt;
|-
</td><td>Creates a bitmap element
|<heading>
</td></tr>
|Creates a heading element, in the document's heading style.
<tr>
|-
<td>&lt;icon&gt;
|<bitmap>
</td><td>Creates an icon element
|Creates a bitmap element
</td></tr>
|-
<tr>
|<icon>
<td>&lt;newline&gt;
|Creates an icon element
</td><td>Creates a newline element, with specified margin and vertical spacing
|-
</td></tr>
|<newline>
<tr>
|Creates a newline element, with specified margin and vertical spacing
<td>&lt;gap&gt;
|-
</td><td>Creates a gap element
|<gap>
</td></tr>
|Creates a gap element.
<tr>
|-
<td>&lt;group&gt;
|<group>
</td><td>Groups several elements together
|Groups several elements together
</td></tr></table>
|}
<p>All document elements have some attributes in common:
 
</p>
 
<ul><li><b>id</b> - ID name for the element, used for programmatic access  
All document elements have some attributes in common:
</li><li><b>group</b> - Group number, used for programmatic document visibility alterations  
 
</li><li><b>format</b> - text formatting, a string including one or more tokens from "bold", "italic", "underline"  
* '''id''' - ID name for the element, used for programmatic access
</li><li><b>align</b> - alignment specification, such as "middle"
* '''group''' - Group number, used for programmatic document visibility alterations
</li></ul>
* '''format''' - text formatting, a string including one or more tokens from "bold", "italic", "underline"
* '''align''' - alignment specification, such as "middle"
 
Feel free to experiment with the '''<documents>''' element now, but be aware that significant changes to the syntax are planned in the future.
 
{{Nav2|Skinning tutorial}}

Latest revision as of 09:03, 7 May 2014

  Languages:

[[::Skinning.documents|English]] • [[::Skinning.documents/de|Deutsch]] • [[::Skinning.documents/es|Español]] • [[::Skinning.documents/fr|Français]] • [[::Skinning.documents/he|עברית]] • [[::Skinning.documents/it|Italiano]] • [[::Skinning.documents/nl|Nederlands]] • [[::Skinning.documents/pl|Polski]] • [[::Skinning.documents/pt|Português]] • [[::Skinning.documents/ru|Русский]] • [[::Skinning.documents/zh-hant|‪中文(繁體)]]

e
  Updated:

This page has been updated on 2014.05.07 for the release of Shareaza v 2.7.x.0.

e

<documents>

The <documents> element provides RichDoc documents that are used within the user interface. At the current time only one Richdoc is used on the Home tab.

RichDoc documents are not HTML, but have some distant similarities. Rather than being a text-parsed language, it is focused on being programmatic so that it may be efficiently updated in real-time without reparsing. It is also very focused, and contains only the basic functionality required to meet its intended purpose (thus eliminating the unnecessary bulk of a full HTML browser).


The RichDoc namespace has not been fully documented yet, but here is a rough guide:


Elements Description
<document> The root document element. Several attribute are available, such as crBackground, crText, etc.
<text> Creates a text element
<link> Creates a hyperlink element, with a target attribute.
<heading> Creates a heading element, in the document's heading style.
<bitmap> Creates a bitmap element
<icon> Creates an icon element
<newline> Creates a newline element, with specified margin and vertical spacing
<gap> Creates a gap element.
<group> Groups several elements together


All document elements have some attributes in common:

  • id - ID name for the element, used for programmatic access
  • group - Group number, used for programmatic document visibility alterations
  • format - text formatting, a string including one or more tokens from "bold", "italic", "underline"
  • align - alignment specification, such as "middle"

Feel free to experiment with the <documents> element now, but be aware that significant changes to the syntax are planned in the future.



Navigation:     ShareazaWiki > Skinning tutorial > Skinning.documents