CMS Made Simple Forums

What Does This Do?

This Module prints out a simple marquee text of your published news articles.
How Do I Use It?

This module depends on the news module. You need to install the news module before you are able to use NFS.

Just place the code " {cms_module module=nfs (params) } " inside your site template or anywhere in your content.
Some params are identical to the news module params. So read news module documentaion for more info.

Notice: not all params of the news module are supported. See the list below what params can be used.

At the adminpanel you can setup the following options:

    * Overwrite Params:
          o All params can also be defined via smarty tag. If this is checked the params in your template won't have any effects to the modules output since the settings of the adminpanel overwrites these params.
            Be sure the option "Overwrite params" is unchecked when using the params via smarty tag.
            Notice: Unchecking this and defining the params in your template may increase frontend performance since the preferences won't be loaded from the database.
            Default is on.

    * Article options
          o News Categories:
                + Usually this will be the categories of your news module.
                  If no categories are found or you select no category the module prints out all articles that are published and can be found in the news database table.
                  This option can be overwritten by using the param "category". This param is identical to the params of the news module.
                  Be sure the option "Overwrite params" is unchecked when using the param "category".
                  Default is no category.

          o Show articles where (some date property) is within the last (some value) (some range):
                + This defines of what timespan the articles will be shown.
                  e.g. Show all articles where the news date is within the last 5 Days.
                  No value or 0 (zero) means that this param will be ignored.
                  Default is "where news date is within the last 14 days".

          o Number of articles:
                + This defines how many articles will be shown.
                  No value or 0 (zero) means that this param will be ignored. (no limit)
                  This option can be overwritten by using the param "number". This param is identical to the params of the news module.
                  Be sure the option "Overwrite params" is unchecked when using the param "number".
                  Default is no limit.

          o Article order:
                + This defines the order of the articles and if this order is displayed ascending or descending.
                  These options can be overwritten by using the params "sortby" and "sortasc". These params are identical to the params of the news module.
                  Be sure the option "Overwrite params" is unchecked when using the params "sortby" and "sortasc".
                  Default is "news_date descending".

    * Display options
          o Use news summary template?:
                + If this is checked the modul uses your news summary template.
                  (You can define this template by using the param "summarytemplate" )
                  If it is not checked the NFS modules default template will be used. (see template tab)
                  Default is not checked.

          o Article seperator:
                + This defines what character(s) seperates the articles from each other.
                  You can also define this by using the param "seperator".
                  Be sure the option "Overwrite params" is unchecked when using the param "seperator".
                  Default is " + + + ".

          o CSS Classname:
                + This defines the classname of the marquee to style it via CSS.
                  You can also define the classname by using the param "class".
                  Be sure the option "Overwrite params" is unchecked when using the param "class".
                  Default ist no classname.

          o CSS Id:
                + This defines the id of the marquee to style it via CSS.
                  You can also define the classname by using the param "id".
                  Be sure the option "Overwrite params" is unchecked when using the param "id".
                  Default ist no id.

    * Scroll options
          o Scroll direction:
                + This defines the scrolling direction of the text.
                  Available options are "from left to right", "from right to left", "from up to down" and "from down to up".
                  You can also define the direction by using the param "direction".
                  Be sure the option "Overwrite params" is unchecked when using the param "direction".
                  Default is "from left to right".

          o Scroll delay:
                + This defines the delay of the text stays at one position before moving of an amount of pixels to the next position. (in milliseconds)
                  The higher this value is the slower scrolls the text.
                  You can also define the delay by using the param "scrolldelay".
                  Be sure the option "Overwrite params" is unchecked when using the param "scrolldelay".
                  Default is "0" ms.

          o Scroll amount:
                + This defines the amount of pixels the text moves from one position to the next.
                  The higher this value is the faster scrolls the text.
                  You can also define the amount by using the param "scrollamount".
                  Be sure the option "Overwrite params" is unchecked when using the param "scrollamount".
                  Default is "1" pixel.

          o Scroll behavior:
                + This defines if the text scrolls just into one direction or if the text scrolls back when reached the border of the marquee.
                  Notice: Alternating text works only if there is enough space to display the whole text. This is no bug of the module but a normal behavior of browsers.
                  You can also define the behavior by using the param "behavior".
                  Be sure the option "Overwrite params" is unchecked when using the param "behavior".
                  Default is "one way".

          o Stop scrolling on mouse over?:
                + When checked the scrolling stops when the mouse cursor position is over the scrolling text.
                  This can be useful if there are links in the text.
                  Notice: Requires JavaScript.
                  You can also define this by using the param "mouseover".
                  Be sure the option "Overwrite params" is unchecked when using the param "mouseover".
                  Default is off.

Available params of the news module

    * dateformat
    * moretext
    * detailtemplate
    * detailpage
    * summarytemplate
    * category
    * showarchive
    * sortby
    * sortasc
    * lang

Change Log

    * Version 1.0 Nov 2007 - Initial Release

Support

This module does not include commercial support.

As per the GPL, this software is provided as-is. Please read the text of the license for the full disclaimer.
Copyright and License

Copyright © Nov 2007, NaN . All Rights Are Reserved.

This module has been released under the GNU Public License. You must agree to this license before using the module.
Dependencies

    * News => 2.5

Parameters

    * (optional) mouseover="stop" - This param defines if the scrolling stops when the the mouse cursor position is over the scrolling text.(requires JavaScript)

    * (optional) id="some id" - This will be the css id of the marquee.

    * (optional) class="some class" - This will be the css classname of the marquee.

    * (optional) scrollamount="1" - This defines the amount of pixels the text moves from one position to the next. The higher this value is the faster scrolls the text.

    * (optional) scrolldelay="0" - This defines the delay of the text stays at one position before moving of an amount of pixels to the next position (in milliseconds). The higher this value is the slower scrolls the text.

    * (optional) behavior="alternate" - This defines if the text scrolls just into one direction or if the text scrolls back when reached the border of the marquee.
      Notice: Alternating text works only if there is enough space to display the whole text. This is no bug of the module but a normal behavior of browsers.

    * (optional) direction="left" - This will define the scrolling direction. Available params are: left (from right to left), right (from left to right), up (from down to up), down (from up to down)

    * (optional) seperator=" + + + " - This defines what character(s) seperates the articles from each other.

    * (optional) articledate="news_date,14,day" - This defines of what timespan the articles will be shown. The first value defines what date property will be considered. Available values are: news_date, start_time, end_time, create_date, modified_date.
      The second value defines the amount of the third value. Available values are numbers only.
      The third value defines the range of the date. Available values are: seconds, minutes, hours, day, week, month, year.

    * (optional) lang="en_US" - El Parámetro se usa para especificar que idioma usar en el frontend. No todos los módulos lo soportan o necesitan.