Difference between revisions of "Print page numbers"

From TMM Wiki
Jump to navigationJump to search
 
(6 intermediate revisions by 4 users not shown)
Line 5: Line 5:
 
= print_page_numbers =
 
= print_page_numbers =
 
* Purpose: Output page number links to content instead of just 'next' and 'previous' links
 
* Purpose: Output page number links to content instead of just 'next' and 'previous' links
* Usage: {carma_list list="actors,locations"}
+
* Usage: {print_page_numbers start=$params.start count=$params.count total=$carma_content_count}
* Required: list
+
* Required: total
* Optional: galid, var, count, start, siteid, section, active, order, alpha_letters
 
 
* Version: 1.4 or greater
 
* Version: 1.4 or greater
 
* Default Templates Used: page_numbers
 
* Default Templates Used: page_numbers
Line 25: Line 24:
 
| How many of the content do we display per page
 
| How many of the content do we display per page
 
| Zero or any whole number greater than zero
 
| Zero or any whole number greater than zero
| 50
+
| 12
 
| count=$params.count
 
| count=$params.count
 
|-
 
|-
 
| [[start]]
 
| [[start]]
 
| What number did the content start displaying at
 
| What number did the content start displaying at
 +
| Any whole number greater than zero
 +
| ''0''
 +
| start=$params.start
 +
|-
 +
| [[total]]
 +
| The total amount of content found
 
| Any whole number greater than zero
 
| Any whole number greater than zero
 
| ''None.'' (Doesn't hide any results)
 
| ''None.'' (Doesn't hide any results)
| start=$params.start
+
| total=$carma_content_count
 
|-
 
|-
 
| [[tpl]]
 
| [[tpl]]
 
| Template to use for showing the output
 
| Template to use for showing the output
| Any whole number greater than zero
+
| Any template that you want to show page numbers
| ''None.'' (Doesn't hide any results)
+
| When no tpl set, page_numbers is used
| start=10
+
| tpl="my_template"
 
|-
 
|-
 
| [[show_pages]]
 
| [[show_pages]]
 
| The amount of page numbers to display to the users
 
| The amount of page numbers to display to the users
 
| Any whole number greater than zero
 
| Any whole number greater than zero
| ''9.'' (Doesn't hide any results)
+
| ''9.''  
 
| show_pages=9
 
| show_pages=9
 
|-
 
|-
Line 60: Line 65:
  
 
== Description ==
 
== Description ==
This function retrieves a list of actors, locations, categories or
+
This function will output a list of page numbers on your website so users can more easily navigate through your content.
groups. By default CARMA retrieves all actors, locations, categories,
 
and groups stored in the CARMA database. If only want to retrieve a
 
list matching a specific gallery, define galid in the call to
 
carma_list. The variables are stored in an array. For example,
 
actors are stored as $carma_list.actor[], categories are stored as
 
$carma_list.category[]. Each item in the array is again an array with
 
each field being one of the fields in the corresponding database table.
 
  
 
== Example Template ==
 
== Example Template ==
 
<pre>
 
<pre>
 
<div class='video_pages'>
 
<div class='video_pages'>
   <div class='video_pages-big'>PAGE {$params.current_page} OF {$params.total_pages}</div>
+
   <div class='video_pages-big'>PAGE {$page_params.current_page} OF {$page_params.total_pages}</div>
 
      
 
      
   {if $params.current_page > 1 }
+
   {if $page_params.current_page > 1 }
     <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start=0&count={$params.count}'>&lt;&lt; FIRST</a></div>
+
     <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start=0&count={$page_params.count}'>&lt;&lt; FIRST</a></div>
     <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="x-y" x=$params.start y=$params.count}&count={$params.count}'>&lt; PREVIOUS</a></div>
+
     <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="x-y" x=$page_params.start y=$page_params.count}&count={$page_params.count}'>&lt; PREVIOUS</a></div>
 
   {else}
 
   {else}
 
     <div class='video_pages-big'>&lt;&lt; FIRST</div>
 
     <div class='video_pages-big'>&lt;&lt; FIRST</div>
Line 83: Line 81:
 
        
 
        
 
   {foreach from=$page_numbers item=page_info}
 
   {foreach from=$page_numbers item=page_info}
     {if $params.current_page == $page_info.page}
+
     {if $page_params.current_page == $page_info.page}
 
       <div class='video_pages-active'>{$page_info.page}</div>
 
       <div class='video_pages-active'>{$page_info.page}</div>
 
     {else}
 
     {else}
       <div class='video_pages-small'><a href='{rebuild_link using="GET" without="start,count"}&start={$page_info.start}&count={$params.count}'>{$page_info.page}</a></div>
+
       <div class='video_pages-small'><a href='{rebuild_link using="GET" without="start,count"}&start={$page_info.start}&count={$page_params.count}'>{$page_info.page}</a></div>
 
     {/if}
 
     {/if}
 
   {/foreach}
 
   {/foreach}
 
        
 
        
   {if $params.current_page < $params.total_pages }
+
   {if $page_params.current_page < $page_params.total_pages }
     <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="x+y+1" x=$params.start y=$params.count}&count={$params.count}'>NEXT &gt;</a></div>
+
     <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="x+y+1" x=$page_params.start y=$page_params.count}&count={$page_params.count}'>NEXT &gt;</a></div>
     <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="(x-1)*y" x=$params.total_pages y=$params.count}&count={$params.count}'>LAST &gt;&gt;</a></div>
+
     <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="(x-1)*y" x=$page_params.total_pages y=$page_params.count}&count={$page_params.count}'>LAST &gt;&gt;</a></div>
 
   {else}
 
   {else}
 
     <div class='video_pages-big'>NEXT &gt;</div>
 
     <div class='video_pages-big'>NEXT &gt;</div>

Latest revision as of 11:27, 20 December 2011

CARMA
  Template Functions
CARMA Template Functions
carma_actor_photo_name
carma_comments_display
carma_comments_form
carma_count
carma_favorite
carma_gal_custom
carma_get_extended
carma_list
carma_list_favorites
carma_list_gals
carma_list_third_party_content
carma_list_videos
carma_login_log
carma_most_viewed
carma_newest
carma_news
carma_poll
carma_retrieve_sections
carma_search
carma_actors_search
carma_show_gal
carma_show_video
carma_top_actors
carma_top_rated
carma_upcoming
print_page_numbers
Template Function Aliases
carma_comment_display
carma_display_comment
carma_display_comments
carma_extended
carma_extended_data
carma_get_extended_data
carma_list_all
Common Parameters
assign
assign_prefix
count
data_only
display_on_assign
start
tpl

print_page_numbers

  • Purpose: Output page number links to content instead of just 'next' and 'previous' links
  • Usage: {print_page_numbers start=$params.start count=$params.count total=$carma_content_count}
  • Required: total
  • Version: 1.4 or greater
  • Default Templates Used: page_numbers
  • Variables created: $first_page, $last_page, $current_page, $total_pages, $page_params

Parameters

(Required parameters in bold)

Parameter Description Possible Values Default Value Example
count How many of the content do we display per page Zero or any whole number greater than zero 12 count=$params.count
start What number did the content start displaying at Any whole number greater than zero 0 start=$params.start
total The total amount of content found Any whole number greater than zero None. (Doesn't hide any results) total=$carma_content_count
tpl Template to use for showing the output Any template that you want to show page numbers When no tpl set, page_numbers is used tpl="my_template"
show_pages The amount of page numbers to display to the users Any whole number greater than zero 9. show_pages=9
current_page The current page that is being shown Any whole number greater than zero Will be calculated on the fly current_page=5
total_pages Total amount of pages that exist Any whole number greater than zero Will be calculated on the fly total_pages=65

Description

This function will output a list of page numbers on your website so users can more easily navigate through your content.

Example Template

<div class='video_pages'>
  <div class='video_pages-big'>PAGE {$page_params.current_page} OF {$page_params.total_pages}</div>
    
  {if $page_params.current_page > 1 }
    <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start=0&count={$page_params.count}'><< FIRST</a></div>
    <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="x-y" x=$page_params.start y=$page_params.count}&count={$page_params.count}'>< PREVIOUS</a></div>
  {else}
    <div class='video_pages-big'><< FIRST</div>
    <div class='video_pages-big'>< PREVIOUS</div>
  {/if}
       
  {foreach from=$page_numbers item=page_info}
    {if $page_params.current_page == $page_info.page}
      <div class='video_pages-active'>{$page_info.page}</div>
    {else}
      <div class='video_pages-small'><a href='{rebuild_link using="GET" without="start,count"}&start={$page_info.start}&count={$page_params.count}'>{$page_info.page}</a></div>
    {/if}
  {/foreach}
       
  {if $page_params.current_page < $page_params.total_pages }
    <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="x+y+1" x=$page_params.start y=$page_params.count}&count={$page_params.count}'>NEXT ></a></div>
    <div class='video_pages-big'><a href='{rebuild_link using="GET" without="start,count"}&start={math equation="(x-1)*y" x=$page_params.total_pages y=$page_params.count}&count={$page_params.count}'>LAST >></a></div>
  {else}
    <div class='video_pages-big'>NEXT ></div>
    <div class='video_pages-big'>LAST >></div>
  {/if}
</div>

Example Function Call

{print_page_numbers start=$params.start count=$params.count total=$carma_content_count}