Differences

This shows you the differences between two versions of the page.

--- te3:toplist_index [2014/10/09 10:38] – [Add new toplist] moderator
+++ te3:toplist_index [2016/05/09 06:21] (current) – [Export toplists to other sites in your Network] moderator
@@ Line 1: / Line 1: @@
-====== Toplist ======
+====== Templates ======
+{{:te3:button_menu2.png?nolink|}}
+~~NOTOC~~
-{{:te3:button_menu_toplist.png?nolink|}} / Toplist
+“Toplist” is a collection of trades in your database that may be ranked in a number of different ways, e.g., by: raws, uniques, clicks, outgoing hits, productivity, value, owed ratio and so on. Number of toplists you can create is basically unlimited.
+----
+===== Toplist syntax =====
+==== Standard template tags ====
+|< 100% 15% 25% 60% >|
+^ Parameter ^ Description ^ Example ^
+| ''##name:x##'' | **Site name** | ''##name:4##'' will print "site name" for trade number ''4''. |
+| ''##domain:x##'' | **Domain name** (domain.com) | ''##domain:6##'' will print "domain name" for trade number ''6''. |
+| ''##raw:x##'' | **Incoming raws** | ''##raw:7##'' will print "incoming raws" for trade number ''7''. |
+| ''##uniq:x##'' | **Incoming uniques** | ''##uniq:3##'' will print "incoming uniques" for trade number ''3''. |
+| ''##clk_t:x##'' | **Clicks sent to trades** | ''##clk_t:4##'' will print "clicks sent to trades" for trade number ''4''. |
+| ''##clk_tg:x##'' | **Clicks sent to trades & galleries** | ''##clk_tg:2##'' will print "clicks sent to trades & galleries" for trade number ''2''. |
+| ''##out:x##'' | **Outgoing hits** | ''##out:5##'' will print "outgoing hits" for trade number ''5''. |
+| ''##out_uniq:x##'' | **Outgoing uniques** | ''##out_uniq:6##'' will print "outgoing uniques" for trade number ''6''. |
+| ''##value:x##'' | **Value of a trade** (Clk T / Out T) | ''##value:2##'' will print "value of a trade" for trade number ''2''. |
+| ''##owed:x##'' | **Owed** (Outgoing list / traffic distribution is based on the owed ratio) | ''##owed:13##'' will print "owed" for trade number ''13''. |
+| ''##ratioraw:x##'' | **Ratio raw** (Out T / Raw) | ''##ratioraw:5##'' will print "ratio raw" for trade number ''5''. |
+| ''##balanceraw:x##'' | **Balance raw** (outgoing total - incoming raws) | ''##balanceraw:3##'' will print "balance raw" for trade number ''3''. |
+| ''##balanceratioraw:x##'' | **Balance ratio raw** (incoming raws / outgoing total) | ''##balanceratioraw:8##'' will print "balance ratio raw" for trade number ''8''. |
+| ''##balanceuniq:x##'' | **Balance uniq** (outgoing total - incoming uniques) | ''##balanceuniq:3##'' will print "balance uniq" for trade number ''3''. |
+| ''##balanceratiouniq:x##'' | **Balance ratio uniq** (incoming uniques / outgoing total) | ''##balanceratiouniq:8##'' will print "balance ratio uniq" for trade number ''8''. |
+| ''##return_url:x##'' | **Return URL** (<nowiki>http://www.example.com/</nowiki>) | ''##return_url:7##'' will print "return URL" for trade number ''7''. |
+| ''##nick:x##'' |** Webmaster's nickname** | ''##nick:2##'' will print "webmaster's nickname" for trade number ''2''. "Nickname" is an optional attribute. If you would like to use this toplist tag, make sure you have it entered. |
+| ''##email:x##'' | **Webmaster's e-mail** | ''##email:8##'' will print "webmaster's e-mail" for trade number ''8''. "E-mail" is an optional attribute. If you would like to use this toplist tag, make sure you have it entered. |
+| ''##icq:x##'' | **Webmaster's ICQ** | ''##icq:5##'' will print "webmaster's ICQ" for trade number ''5''. "ICQ" is an optional attribute. If you would like to use this toplist tag, make sure you have it entered. |
+==== Advanced template tags ====
+=== Descriptions ===
+Learn everything about "Description tags" and how to use them [[te3:toplist_descriptions|here]]!
+=== Images ===
+Learn everything about "Image tags" and how to use them [[te3:toplist_images|here]]!
+=== History ===
+To display history stats on the toplist, select ''History'' from the ''Type'' pulldown in the "Add new" toplist window. Use the same toplist tags as you use for the last 24h toplist, but add ''<color blue>h_</color>'' in front of the tags (e.g. instead of ''##raw:x##'' use ''##<color blue>h_</color>raw:x##'').
-{{INLINETOC}}
 ----
-==== Add new toplist ====
+===== Create a toplist =====
+We have prepared tutorials for various types of toplists - learn how to create a:
-To create a new toplist, navigate to the Toplist / Index & Templates menu and click on the {{:te3:interface_plus.png?nolink|}}''Add new'' button. In the "Add new toplist window" you can choose between two different input methods:
+  * [[te3:toplist_tutorial1|Text toplist]] \\ \\
+  * [[te3:toplist_tutorial2|Description toplist]] \\ \\
+  * [[te3:toplist_tutorial3|Thumb toplist]] \\ \\
+  * [[te3:toplist_tutorial4|History toplist]]
-      - {{:te3:button_toplist_form.png?nolink|}} (Web) \\ To add toplist template directly from the admin interface, select ''Form input'' method from the toolbar of the"Add new" toplist window. For the start, you can copy-paste the example template ([[te3:toplist_index&#example_template|below]]) into the ''Toplist template'' field. Specify where would you like to save your template in the ''Save template as'' field, e.g., ''/full/path/to/public_html/your_directory/toplist/toplist_name.tpl'' \\ Next, you have to enter ''File output path'', e.g., ''/full/path/to/public_html/your_directory/toplist/toplist_name.html'' \\ \\
-      - {{:te3:button_toplist_file.png?nolink|}} (FTP) \\ Open your favorite text editor, copy-paste the example template (below), save it as, e.g., ''toplist.tpl'' and upload it by using "FTP" into the ''public_html'' directory on your server. Select ''File input'' method from the toolbar of the "Add new" toplist window. Specify ''Template file input'' as ''/full/path/to/public_html/your_directory/toplist/toplist_name.tpl'' and ''Toplist file output'' as ''/full/path/to/public_html/your_directory/toplist/toplist_name.html''
-The rest of the fields in the "Add toplist" window should be self-explainable.
 ----
+===== Manage toplists =====
+In the “Toplist /Templates” menu you can manage all your toplist from a single page - you can add new toplists, edit existing ones, preview them and more.
-==== Standard template tags ====
+{{:te3:toplis7.png?nolink|}}
+|< 100% 3% 14% 83% >|
+^ # ^ Action ^ Description ^
+| 1. | File input path | Full path to your template file. |
+| 2. | File output path | Location (full path) where you want your toplist to be created. |
+| 3. | Filter by niche | Displays the number [[te3:niches|niches]], your toplist is filtered by. You can create a toplist based on ''None'' (all trades included), one or multiple niches. |
+| 4. | Sort by | Displays the parameter your toplist is sorted by (''raw'', ''Uniq'', ''Clk T''...) . |
+| 5. | Type | Toplists are based on the last 24h statistics by default. They can also be based on [[te3:toplist_tutorial4|history statistics]]. |
+| 6. | Update | Update toplist every ''x'' minutes. |
+| 7. | Generate time | The date and time the respective toplist was last generated. |
+| 8. | Preview | {{:te3:button_preview2.png?nolink|}} Preview the respective toplist. |
+| 9. | Delete | {{:te3:blacklist_delete.png?nolink|}} Delete the respective toplst. |
+| 10. | Fill empty spots | Fill empty slots with "Add your site" links - webmasters can sign-up for a trade with your site through your [[te3:signup|Trade sign-up page]]. |
+| 11. | Edit | {{:te3:overview_edit_icon.png?nolink|}} Edit the respective toplist. |
+| 12. | Generate | {{:te3:button_generate.png?nolink|}} Generate the respective toplist. |
-    ##name:x## - site name
+ \\
-    Example: ##name:4## will print "site name" for trade number 4.
-    ##domain:x## - domain name (domain.com)
-    Example: ##domain:6## will print "domain name" for trade number 6.
-    ##raw:x## - incoming raws
+----
-    Example: ##raw:7## will print "incoming raws" for trade number 7.
-    ##uniq:x## - incoming uniques
+==== Mass edit toplists ====
-    Example: ##uniq:3## will print "incoming uniques" for trade number 3.
-    ##clk_t:x## - clicks sent to trades
+“Mass edit panel” allows you to perform the same action (''Mass edit'', ''Generate'', ''Delete'') on multiple toplists at the same time. Check box toplists in the "Existing" table and “Mass edit panel” will automatically slide-up from the bottom.
-    Example: ##clk_t:4## will print "clicks sent to trades" for trade number 4.
-    ##clk_tg:x## - clicks sent to trades & galleries
+=== Edit toplists step by step ===
-    Example: ##clk_tg:2## will print "clicks sent to trades & galleries" for trade
+{{:te3:tpl_mass_edit1.png?nolink|}} \\
-    number 2.
+{{:te3:tut_step_1.png?nolink|}} Check box toplists you wish to edit.
-    ##out:x## - outgoing hits
+{{:te3:tut_step_2.png?nolink|}} Select ''Mass edit'' from the "Mass edit panel".
-    Example: ##out:5## will print "outgoing hits" for trade number 5.
-    ##out_uniq:x## - outgoing uniques
+{{:te3:tut_step_3.png?nolink|}} Edit settings for the selected toplists in "Mass edit" window.
-    Example: ##out_uniq:6## will print "outgoing uniques" for trade number 6.
-    ##value:x## - value of a trade (Clk T / Out T)
+{{:te3:tut_step_4.png?nolink|}} Click {{:te3:button_save.png?nolink|}} to confirm your settings.
-    Example: ##value:2## will print "value of a trade" for trade number 2.
-    ##owed:x## - owed (Outgoing list / traffic distribution is based on the owed
+ \\
-     ratio)
-    Example: ##owed:13## will print "owed" for trade number 13.
-    ##ratioraw:x## - ratio raw (Out T / Raw)
-    Example: ##ratioraw:5## will print "ratio raw" for trade number 5.
-    ##balanceraw:x## - balance raw (outgoing total - incoming raws)
+----
-    Example: ##balanceraw:3## will print "balance raw" for trade number 3.
-    ##balanceratioraw:x## - balance ratio raw (incoming raws / outgoing total)
+==== Export toplists to other sites in your Network ====
-    Example: ##balanceratioraw:8## will print "balance ratio raw" for trade number 8.
-    ##balanceuniq:x## - balance uniq (outgoing total - incoming uniques)
+You can export your toplists to other sites in your [[te3:network|Network]]. TE3 will automatically change the file paths for exported toplists.
-    Example: ##balanceuniq:3## will print "balance uniq" for trade number 3.
-    ##balanceratiouniq:x## - balance ratio uniq (incoming uniques / outgoing total)
+=== Step by step ===
-    Example: ##balanceratiouniq:8## will print "balance ratio uniq" for trade
-     number 8.
-    ##return_url:x## - return URL ( http://www.example.com/ )
-    Example: ##return_url:7## will print "return URL" for trade number 7.
-    ##nick:x## - webmaster's nickname
+{{:te3:export_toplis1t.png|}}
-    Example: ##nick:2## will print "webmaster's nickname" for trade number 2.
-    "Nickname" is an optional attribute. If you would like to use this toplist tag,
-    make sure you have it entered.
-    ##email:x## - webmaster's e-mail
-    Example: ##email:8## will print "webmaster's e-mail" for trade number 8. "E-mail"
-    is an optional attribute. If you would like to use this toplist tag, make sure
-    you have it entered.
-    ##icq:x## - webmaster's ICQ
-    Example: ##icq:5## will print "webmaster's ICQ" for trade number 5. "ICQ" is an
-    optional attribute.If you would like to use this toplist tag, make sure you have
-    it entered.
-----
+{{:te3:tut_step_1.png|}} Check box preferred toplists in the “Existing” table,
-==== Example template ====
+{{:te3:tut_step_2.png|}} Choose "Export to network" option from the "Mass edit panel";
+{{:te3:tut_step_3.png|}} Select the sites in your [[te3:network|network]], you want to export toplists to;
+{{:te3:tut_step_4.png|}} Click "Export" button.
-Example toplist:
-    <table>
-    <tr><td><a href="/te3/out.php?id=##domain:1##">##name:1##</a></td></tr>
-    <tr><td><a href="/te3/out.php?id=##domain:2##">##name:2##</a></td></tr>
-    <tr><td><a href="/te3/out.php?id=##domain:3##">##name:3##</a></td></tr>
-    </table>
-----
-==== Advanced template tags ====
-Learn everything about "Description tags" and how to use them [[te3:toplist_descriptions|here]]!
-Learn everything about "Image tags" and how to use them [[te3:toplist_images|here]]!
-----
-====  History ====
-To display history stats on the toplist, select ''History'' from the ''Type'' pulldown in the "Add new" toplist window. Use the same toplist tags as you use for the last 24h toplist, but add ''h_'' in front of the tags.
-Example: Last 24h tag for "incoming raws" looks like this: ''##raw:x##'', while history tag for "incoming raws" looks like this: ''##h_raw:x##''.
-<color grey>Of course you should only add ''h_'' in front of the tags where it makes sense. You can't add ''h_'' in front of the tags such as: ''return_url'', ''domain'', ''nick'', ''email'', ''icq''...</color>
-==== How to include toplist into your web page ====
-  * PHP (.php pages)
-    <code>
-    <?php
-    include "toplist.html";
-    ?></code>
-  * SSI (.shtml pages)
-    <code><!--#include virtual="toplist.html" --></code>