summaryrefslogtreecommitdiff
path: root/plugins/Clist_modern/docs
diff options
context:
space:
mode:
authorGeorge Hazan <george.hazan@gmail.com>2012-06-17 12:44:02 +0000
committerGeorge Hazan <george.hazan@gmail.com>2012-06-17 12:44:02 +0000
commitf673f034c2fef25e932a12fbd5e2772f90c75e6d (patch)
treeaeaac57c13fd2a23e47e437d804957d67e5413ee /plugins/Clist_modern/docs
parentbce08282b66209eb482726a7ec6c89083db327ac (diff)
Clist_mw & Clist_modern renamed
git-svn-id: http://svn.miranda-ng.org/main/trunk@455 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c
Diffstat (limited to 'plugins/Clist_modern/docs')
-rw-r--r--plugins/Clist_modern/docs/FAQ[En].txt18
-rw-r--r--plugins/Clist_modern/docs/ReadMe.txt101
-rw-r--r--plugins/Clist_modern/docs/skinpp.txt148
-rw-r--r--plugins/Clist_modern/docs/template.txt25
4 files changed, 292 insertions, 0 deletions
diff --git a/plugins/Clist_modern/docs/FAQ[En].txt b/plugins/Clist_modern/docs/FAQ[En].txt
new file mode 100644
index 0000000000..ac5fc14a08
--- /dev/null
+++ b/plugins/Clist_modern/docs/FAQ[En].txt
@@ -0,0 +1,18 @@
+FAQ:
+
+Here I will try to collect more recently questions.
+
+Q: I installed (copied) clist_modern to plugins folder but it is not appears/works/etc.) I use latest Miranda 0.4.0.3. Why it is not work?
+A: The Modern Contact list module WORKS ONLY WITH latest ALPHA BUILDS #0.4.3.45 and latest. Download it from http://blog.miranda-im.org/
+
+Q: What is ANSI and UNICODE version what difference is?
+A: Unicode and ANSI are text coding schemas. UNICONE is newest and allows to use several languages including Chinese etc. in same program. But ANSI allows use only two: English and one other (Cyrillic or Eastern European etc.) ANSI is former encoding and support native by any versions of Windows. Unicode is supported only by Windows 200 and later.
+
+Q: What OS supported?
+A: Windows XP preferred (I use it for development and myself and tested on it), Windows 2000 (I not tested it but it should work with may be some glitches), old systems like Windows 9x, ME – not tested and if it will work it will be with limitation (this OSes not support layered windows).
+
+Q: What are third parties libraries required for modern?
+A: Modern required engine to load PNG images. It can be GDI+ engine (pre-installed with Windows XP, Microsoft Office XP or can be download and installed from microsoft) or imagedecoder.dll. (last can be required for other plugins like loadavatars etc.)/ Without it skins used semitransparent images (almost all) can be loaded incorrectly (this images will be absent).
+
+Q: How I can notice about any issues inn modern or request some new features?
+A: Use http://modern.saopp.info/bugs
diff --git a/plugins/Clist_modern/docs/ReadMe.txt b/plugins/Clist_modern/docs/ReadMe.txt
new file mode 100644
index 0000000000..bc1f640c54
--- /dev/null
+++ b/plugins/Clist_modern/docs/ReadMe.txt
@@ -0,0 +1,101 @@
+-----------------------
+MODERN ROW DESIGN GUIDE
+-----------------------
+
+New engine logic is very similar to HTML. Each contact rows are
+represented as table. Table devided to rows or columnts. Contact list row
+items specified as attribute of some table cells.
+
+1. Tags
+-------
+There are two tags described cell containers:
+<tr> - specify that cell is row.
+<tc> - specify that cell is column.
+Tags are pair and should be correspondingly closed by </tr> or </tc>
+Also allowed short form: <tr ... /> , <tc ... />.
+NOTE: There should be space before close brace: '...[space]/>'.
+
+In general rows can contain only column an vise versa.
+
+2. Attributes
+-------------
+Each container can contain several attributes:
+a) attributes of cell type if one of following attribute presents
+ appropriate contact list row item will be painted there.
+
+ * avatar - contact's avatar
+ * status - contact's status icon
+ * time - contact local time
+ * extra - contact associated extra images
+ * text1, text2, text3 - contact text lines
+
+ NOTE: trere are two additional attributes:
+
+ * space - empty space with dinamic width
+ * fspace - empty space with fixed width
+
+b) attributes of size (applicable only if space and fspace specified)
+
+ * width - width of space (for dynamic width spaces see bellow)
+ * height - height of space
+
+ NOTE: value of each attributes should be specified after space
+ like: 'width 10 height 5'
+
+c) attributes of aligment:
+
+ * left, hcenter, right - horizontal aligment (left, center, right)
+ * top, vcenter, bottom - vertical aligment (top, center, bottom)
+
+ NOTE: default aligment is 'left top'
+
+d) special attribute
+
+ * layer - meaning that such container is in new layer.
+
+3. Comments and separators
+-----------
+
+ All charecters from ';' to the end of line are ignored and can be used
+ as comments for template.
+
+ Template are case insensitive. Tags and attributes are separated by
+ spaces. Several consiquent spaces are threats as one.
+
+ NOTE: there should NOT be spaces beetween
+ * '<' and 'tr' or 'tc';
+ * '<' and '/' and 'tr' or 'tc'
+ * '/' and '>'
+
+4. Rules for use
+----------------
+
+- Whole contact row represents with one of outside tag <tr> or <tc>,
+ other should be inside this.
+
+ e.g.
+ <tr> ; this represent whole contact list row and means that
+ ; inside should be columns
+ <tc .. />
+ ...
+ <tc .. />
+ </tr> ; end of parsing here
+
+- Size of parents elements are defined by size of they child as follow:
+
+ * width of 'row' parent is maximum value from sum of width 'columns'
+ inside and maximum width of all layer childs.
+
+ * height of 'column' parent is maximum value from sum of height
+ 'height' inside and maximum height of all layer childs.
+
+ * width of 'column' parent and height of 'row' parent are the
+ maximum of appropriate value of childs.
+
+- Minimum size of cells with specified attributes wich described in
+ section 2a is size of appropriate elements (except of width of texts
+ and dynamic width space)
+
+- Width of dynamic width elements (texts and space) determine as folow:
+
+...
diff --git a/plugins/Clist_modern/docs/skinpp.txt b/plugins/Clist_modern/docs/skinpp.txt
new file mode 100644
index 0000000000..0620926043
--- /dev/null
+++ b/plugins/Clist_modern/docs/skinpp.txt
@@ -0,0 +1,148 @@
+//////////////////////////////////////////////////////////////////////////
+// This is brief description of skin engine xml format //
+//////////////////////////////////////////////////////////////////////////
+
+
+/************************************************************************\
+ Common object description format:
+--------------------------------------------------------------------------
+
+...
+ <object.name type='glyph'>
+ <fonts>
+ <main effort='255' color='0x000000' alpha='255' effect='none' effect.color='0x000000' effect.alpha='255' />
+ <second effort='255' color='0x000000' alpha='255' effect='none' effect.color='0x000000' effect.alpha='255' />
+ <third effort='255' color='0x000000' alpha='255' effect='none' effect.color='0x000000' effect.alpha='255' />
+ </fonts>
+ <....>
+ </object.name>
+...
+
+Attributes:
+
+ type - the type of object: possible values are 'glyph', 'solid', 'gradient', 'none'
+ default is 'none'
+
+
+ The 'fonts' section describes modifiers of user font. if specific attribute is not
+specified - means do not change user setted one. E.g if only 'color' attribute is
+specified - this color will be used instead of user requested.
+
+ If several painting are occurs before text rendering - the settings will be accumulated.
+ If several same settings are will be accumulated - the last one will be used as result.
+But 'effort' attribute is show the '255'-based effort of specified value (for color only)
+to be combined the old color and new one like:
+ result_color=(old_color*(255-effort)+newcolor*(effort))/255;
+the resultet color will be same like this opacity effect.
+
+Subsections:
+
+ main - info regarding main font: Nick for contacts or groupname for groups.
+ second - info about second font: Second row line for contacts or group counter
+ third - info about third font: Third row line for contacts, top color of group divider
+ fourth - info about fourth font: Time for contacts or bottom color of group divider
+
+Attributes:
+
+
+
+
+
+/************************************************************************\
+ Glyph object description format:
+--------------------------------------------------------------------------
+
+...
+ <object.name type='glyph' opacity='255'>
+ <image file="filename.png" x='0' y='0' width='0' height='0' />
+ <resize top='0' left='0' bottom='0' right='0' mode='tile' />
+ <....>
+ </object.name>
+...
+
+The Glyph Object is described within <object.name> node.
+ Attributes:
+
+ opacity - object opacity, numeric, [0..255], default is 255.
+
+The image is described in <image> subnode.
+ Attributes:
+
+ file - image file name relative to skin root folder,
+ default is empty - mean internal clist modern skin image.
+ x, y - top left corner of fragment on image map - default are (0,0)
+ width, height - width and height of fragment image, default
+ are image size minus top-left corner coordinate.
+
+The second subnode is <resize> - describe how to fill requested area
+if glyph image is too small:
+ Attributes:
+
+ top, bottom, left, right- the constant margins on sides, default are 0
+ mode - the how to fill mode,
+ possible values: tile, vtile, htile, stretch - (tile both
+ directions, tile vertical, tile horizontal, stretch
+ both directions), default is 'stretch'
+
+
+
+
+********** Example of skin ***************
+
+<skin>
+<!-- Skin Info (about, author, etc.) -->
+ .....
+
+<!-- Properties (margins, db settings) -->
+ <skin.properties>
+ ....
+ </skin.properties>
+
+ <? include="./xml_file_to_be_included.xml" ?>
+
+<!-- Objects (objects to be drawn) -->
+ <skin.objects>
+ <object.name type='glyph' opacity='255'>
+ <image file="filename.png" x='0' y='0' width='0' height='0' />
+ <resize top='0' left='0' bottom='0' right='0' mode='tile' />
+ <fonts>
+ <main effort='255' color='0x000000' alpha='255' effect='none' effect.color='0x000000' effect.alpha='255' />
+ <second effort='255' color='0x000000' alpha='255' effect='none' effect.color='0x000000' effect.alpha='255' />
+ <third effort='255' color='0x000000' alpha='255' effect='none' effect.color='0x000000' effect.alpha='255' />
+ </fonts>
+ </object.name>
+ .....
+
+ </skin.objects>
+
+<!-- Selectors (selector what need to be drawn) -->
+ <skin.selectors>
+ ....
+ </skin.selectors>
+
+<!-- Buttons -->
+ <skin.buttons>
+ ....
+ </skin.buttons>
+
+<!-- Row Layout (layout of row) -->
+ <skin.rowlayout>
+ <tr>
+ <tc valign='vcenter'>
+ <tr valign='vcenter' halign='hcenter'>
+ <tc valign='vcenter' halign='hcenter' draw='avatar' />
+ <tc mode='layer' valign='bottom' halign='right' draw='icon' />
+ </tr>
+ </rc>
+ <tc valign='vcenter'>
+ <tr draw='text' />
+ <tr draw='text2' />
+ <tr draw='text3' />
+ </tc>
+ <tc mode='layer' valign='top' halign='right' draw='extra' />
+ </tr>
+ </skin.rowlayout>
+...
+</skin>
+
+\************************************************************************/ \ No newline at end of file
diff --git a/plugins/Clist_modern/docs/template.txt b/plugins/Clist_modern/docs/template.txt
new file mode 100644
index 0000000000..e1a9654bf1
--- /dev/null
+++ b/plugins/Clist_modern/docs/template.txt
@@ -0,0 +1,25 @@
+<tc>
+ <tr vcenter>
+ <tc status vcenter hcenter />
+ <tc fspace width 2 />
+ <tc vcenter>
+ <tr left vcenter>
+ <tc vcenter text1 />
+ <tc fspace width 2 />
+ </tr>
+ <tr fspace height 1 />
+ <tr left vcenter>
+ <tc vcenter text2 />
+ <tc fspace width 2 />
+ <tc vcenter text3 />
+ <tc fspace width 2 />
+ <tc vcenter extra />
+ </tr>
+ </tc>
+ <tc>
+ <tr layer right vcenter avatar />
+ </tc>
+
+ </tr>
+ <tr layer right top time />
+</tc>