Joomla Documentation

Welcome to the product documentation section. Here you will find installation guides, quick-references and more information for our Joomla! extensions and templates.

Timeline

JoomlaXTC Timeline

JoomlaXTC Timeline component provides an easy way to implement VéritéCo's Timeline library on Joomla! to create smooth and sleek slideshows of content organized by date from sources such as Joomla! articles, K2 items, GoogleDocs or custom-made timelines.

Each content item can contain media elements such as the following:
  • Plain text
  • Image in PNG/JPEG/GIF formats
  • YouTube
  • Vimeo
  • DailyMotion
  • Wikipedia
  • Twitter
  • Google maps
  • Google Docs
  • Flicker
  • Instagram
  • Soundcloud
  • Web site
Installation
Download the ZIP file and then use the Joomla Extension Manager to install it on your website.
The Timeline Browser
The timeline display works as a browser where you can navigate thru multiple content items organized by time. There are several parts in the display:
Publishing Timelines
To publish a Timeline in your website just go to the Menu Manager, navigate to any Menu options and select Add New Menu Item: Then, use the Menu Item Type parameter to select any of Timeline's view options: Each type of view has specific parameters and behavior. They are explained below:
Joomla! Content timeline
In this view, the Timeline browser is built using Joomla! article information from one or more categories. The Published date of an article is used to organize the content for the browser and the Intro text is shown as content. If the Intro text contains only a single URL, then the URL will be used to include an external media resource.

These are the menu options available:
CategoriesSelect one or more categories where to choose articles from. Option ALL CATEGORIES will display articles from all categories. Be wary this may cause slow response times if you have many articles.
AuthorsSelect one or more author usernames to choose articles from. The option ALL AUTHORS will disable the filter.
Include FeaturedSelect what kind of articles to show according to their Featured attribute.
Include ArchivedEnable this option if you wish to include articles marked as Archived.
Max. ArticlesA value other than zero will restrict the timeline display to have only as many articles. For example, if you enter a value of 25, only the 25 most recent articles will be shown.
Intro ArticleThe Timeline display can contain an introduction item; you can choose what article will be used with this parameter.
ThemeYou can select a Theme to style the timeline display. More information about Themes is given below.
Display HeightEnter a numeric value to set the height of the display (in pixels). Consider that timeline displays need to have plenty of space to look right.
Include Fulltext?If you have entered a single URL as Intro text (to display a media element), you can choose to display the Full text as well.
Show 'Read more' link?If enabled, this will display a "Read more" button after the article text pointing to the original Joomla article page.
Start from End?This will make the timeline display start by the last (most recent) article.
K2 Content timeline
Provided you have installed the K2 component, you can fetch K2 item information in a similar way than Joomla. The same rules apply to K2 content items.

These are the menu options available:
CategoriesSelect one or more categories to use. Option ALL CATEGORIES will display items from all categories. Be wary this may cause slow response times if you have many content items.
AuthorsSelect one or more author usernames to choose items from. The option ALL AUTHORS will disable the filter.
TagsSelect one or more tags to filter items.
Include FeaturedSelect what kind of articles to show according to their Featured attribute.
Max. ItemsA value other than zero will restrict the timeline display to have only as many items. For example, if you enter a value of 25, only the 25 most recent items will be shown.
Intro ItemThe Timeline display can contain an introduction item; you can choose what item will be used with this parameter.
ThemeYou can select a Theme to style the timeline display. More information about Themes is given below.
Display HeightEnter a numeric value to set the height of the display (in pixels). Consider that timeline displays need to have plenty of space to look right.
Include Fulltext?If you have entered a single URL as Intro text (to display a media element), you can choose to display the Full text as well.
Show 'Read more' link?If enabled, this will display a "Read more" button after the item text pointing to the original K2 item page.
Start from End?This will make the timeline display start by the last (most recent) item.
Google Docs spreadsheet timeline
Content can also be obtained from a public Google Docs spreadsheet with the right format.

These are the menu options available:
Spreadsheet URLEnter the Google Docs URL for the spreadsheet. The document must be publicly available and with the right column format (see below).
ThemeYou can select a Theme to style the timeline display. More information about Themes is given below.
Display HeightEnter a numeric value to set the height of the display (in pixels). Consider that timeline displays need to have plenty of space to look right.
Start from End?This will make the timeline display start by the last (most recent) item.

The spreadsheet must contain a timeline item entry on each row and certain columns whether they are filled or not for a particular entry. You can see the demo document in the following URL:

https://docs.google.com/spreadsheet/pub?key=0Agl_Dv6iEbDadHdKcHlHcTB5bzhvbF9iTWwyMmJHdkE&output=html


The columns, from left to right are as follows:
Start DateThe starting date of the entry, this is a required field. For better results use this format: MM/DD/YY HH:MM:SS
End DateAn optional ending date of the entry. For better results use this format: MM/DD/YY HH:MM:SS
HeadlineThe text to be used as entry title or headline.
TextThe entry text to be shown.
MediaAn optional URL pointing to any of the supported media elements.
CreditsText to be used for credits of the media element.
CaptionText to be used for the media element caption.
Title SlideUse a cell value of "start" to mark which entry will serve as the introductory slide.
For better clarity, make the cells on the first row to be the name of the columns, and then create a timeline entry on every row according to your needs. To include an external media element type the corresponding URL in the "Media" column cell.
Custom timeline
Select any of the custom-made timelines built using the component editor. See below for detailed instructions on how to create your own timelines.

These are the menu options available:
TimelineChoose any of the custom timelines available.
ThemeYou can select a Theme to style the timeline display. More information about Themes is given below.
Display HeightEnter a numeric value to set the height of the display (in pixels). Consider that timeline displays need to have plenty of space to look right.
Start from End?This will make the timeline display start by the last (most recent) item.
Enable Content plugins?Sometimes you may want to add additional features to a timeline slide using Joomla! content plugins. Use this parameter to enable Content plugins for the timeline slides. Be aware the complexity and requirements of plugins may conflict with the behavior and styling of the timeline itself. Your mileage may vary.
Creating Custom Timelines
You can easily create one or more custom timelines using the component itself. Making a custom timeline is a two-step process where you create a timeline record first, then add as many entries you want to it. To create the Timeline record just navigate to the administration page of your website and choose the JoomlaXTC Timeline menu entry from the Components menu. You will see a page like the following: The Timelines page will show any existing Timelines available on the component. Clicking on a Timeline name or the New icon in the top right opens the Timeline editor: The editor allows to enter the specific features of the timeline in the following fields:
Details
This section has the basic information of the Timeline itself.
TitleThe title of the Timeline. This field is required and used to reference the timeline but the text is not shown in the frontend display.
NotesThis field is optional, it can contain any comments or notes intended for the administrator. The text is not shown anywhere else.
Content
This section is optional. If needed, you can enter the information for an "Introduction" slide just as if it were a regular timeline entry.
Start DateThis field is mandatory; it marks the beginning date of the entry.
End DateThis field is optional; it marks the end date of the entry.
HeadlineThe headline or title text for the slide.
TextMain text for the slide.
URLAn optional URL pointing to any of the supported external media elements.
CreditText to be placed as credit of the slide media element.
CaptionText for the caption note of the media element.
Once you edit the information of a Timeline record, click on the Save & Close or Save icons in the top right corner to save your changes.

Back in the Timeline list view, you can go to the Entries list page by using the appropriate menu option, clicking on the Entries link in the navigation bar or clicking on the name of a Timeline record: And similar to the Timeline list page, you can click on the New icon or the name of an entry to open up the Entry Editor page: The fields are very similar to the Timeline record with only a few changes, these are the fields available for the Timeline entries:
Details
Start DateThis field is mandatory; it marks the beginning date of the entry.
End DateThis field is optional; it marks the end date of the entry.
TimelineHere you can select a Timeline to assign this particular entry to. Choose any of the previously made Timeline records.
HeadlineThe headline or title text for the slide.
TextMain text for the slide.
PublishedYou can mark the entry as Published or Unpublished. Unpublished entries will not be included in the timeline display.
Media
URLAn optional URL pointing to any of the supported external media elements.
CreditAn optional text to be placed as credit of the slide media element.
CaptionAn optional text for the caption note of the media element.
Once an entry is saved, it will be automatically included in the display of the selected Timeline (if published).

When adding entries, try to keep the amount of text to a minimum. Use one or two lines only and also keep in mind the actual display may require a large screen real-estate.
Themes
JoomlaXTC Timeline supports the use of different styling per display. There are a few examples included that can be used for generic purposes however your website design may need you to change or customize them. It is advisable to never touch any of the original files that come with the component, instead, make a copy of an existing theme and do your changes in that copy. This way you will still have the original for reference purposes and also your work won't be lost if you update/reinstall the extension in the future.

To create a copy of a theme, simply look in the components/com_jxtctimeline/themes folder and you will see multiple subfolders. Each folder contains its own styling elements. For example, to copy the default theme simply make a copy of the folder and name it differently, like mytheme.

Inside the folder you will see a file called timeline.css, it contains the CSS code to style the display. You will also see a file called timeline.png, this is an image file containing all the graphic elements. You can edit them to make any necessary changes; however they must maintain the same filenames and CSS classes.

Once you have finished your customizations, go to any of the Menu entries for Timeline and change the theme parameter to use your new folder.

Copyright 2012 Monev Software LLC
www.joomlaxtc.com

Security Notice

JoomlaXTC does not sell it's products on 3rd party sites.  Any website offering JoomlaXTC products for sale are not licensed versions and should be considered a scam.

Never download our products from file sharing websites like rapidshare, torrents or warez forums.

We have received reports of malicious versions of our software containing viruses, extra code, and even once installed, delete your database, steal sensitive information such as passwords, and credit card information. 

There is only one place to get the full and safe licensed versions of our software and you're looking at it!   Enjoy.

Joomla! is Free Software released under the GNU/GPL License. Joomla is a trademark of Open Source Matters and the name is used under a limited license from Open Source Matters in the United States and other countries. joomlaxtc.com / Monev Software LLC is not affiliated with or endorsed by Open Source Matters or the Joomla! Project.