plugin:anewssystem
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:anewssystem [2013-04-16 21:43] – Taggic | plugin:anewssystem [2023-10-31 00:32] (current) – Klap-in | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== anewssystem Plugin ====== | ====== anewssystem Plugin ====== | ||
- | |||
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
- | author | + | author |
email : Taggic@t-online.de | email : Taggic@t-online.de | ||
type : syntax | type : syntax | ||
- | lastupdate : 2013-04-16 | + | lastupdate : 2016-06-02 |
- | compatible : rincewind, angua, adora belle | + | compatible : Weatherwax, Binky, Ponder Stibbons, Hrun, !Hogfather |
depends | depends | ||
conflicts | conflicts | ||
similar | similar | ||
tags : NEWS, newssystem, newspaper | tags : NEWS, newssystem, newspaper | ||
- | screenshot_img: | ||
downloadurl: | downloadurl: | ||
- | bugtracker : http:// | + | bugtracker : #http:// |
sourcerepo : https:// | sourcerepo : https:// | ||
donationurl: | donationurl: | ||
+ | |||
+ | screenshot_img: | ||
---- | ---- | ||
- | \\ | + | :!: The version 2012-07-17 modified the meaning of parameter prev_length. Now it is a threshold for the max previewed words. Please consider to change global config and syntax lines accordingly. |
- | :!: The version 2012-07-17 modified the meaning of parameter prev_length. Now it is a threshold for the max previewed words. Please consider to change global config and syntax lines accordingly. | + | |
- | \\ | + | |
- | :!: The version 2012-05-09 introduced tags. Formerly created news does not have such and might be not visible by given date-validity \\ due to tags used as filter. To make them visible edit the news article and add "'' | + | |
- | \\ | + | |
- | :!: Take care that since version 2012-03-29 you need a modification of formerly created news articles. \\ Open your // | + | |
+ | :!: The version 2012-05-09 introduced tags. Formerly created news does not have such and might be not visible by given date-validity due to tags used as filter. To make them visible edit the news article and add "'' | ||
+ | :!: Take care that since version 2012-03-29 you need a modification of formerly created news articles. \\ Open your // | ||
- | __**Changes**__ \\ | + | ==== Changes |
- | {{rss>http:// | + | |
+ | {{rss>https:// | ||
===== Overview ===== | ===== Overview ===== | ||
+ | |||
The plugin delivers you three major functions (write news, news flash, read all). You are supported by a simple form to write the article. There you can also specify when the news will be visible and until when. Beside writing news articles you can put a NEWS flash box wherever you want (usually on the start page of your wiki). It will provide a preview of the news you want to tell the world linked to the complete content. Another function is to read the complete set of articles you have written. The news data will be stored into one text file, which can be edited by DokuWiki implemented editor as any other page. The previews also as the complete article are allowed to contain DokuWiki syntax. This will be rendered properly. | The plugin delivers you three major functions (write news, news flash, read all). You are supported by a simple form to write the article. There you can also specify when the news will be visible and until when. Beside writing news articles you can put a NEWS flash box wherever you want (usually on the start page of your wiki). It will provide a preview of the news you want to tell the world linked to the complete content. Another function is to read the complete set of articles you have written. The news data will be stored into one text file, which can be edited by DokuWiki implemented editor as any other page. The previews also as the complete article are allowed to contain DokuWiki syntax. This will be rendered properly. | ||
Line 46: | Line 45: | ||
==== Installation ==== | ==== Installation ==== | ||
- | Install the plugin using the [[Doku> | ||
- | Refer to [[Doku> | ||
- | | + | Search and install the plugin using the [[plugin: |
+ | |||
+ | Further: | ||
+ | |||
+ | | ||
~~NOCACHE~~ | ~~NOCACHE~~ | ||
**[ [[news: | **[ [[news: | ||
Line 60: | Line 61: | ||
</ | </ | ||
- create a page news: | - create a page news: | ||
- | - create a page news: | + | - create a page news: |
~~NOCACHE~~ | ~~NOCACHE~~ | ||
{{anss> | {{anss> | ||
==== The Author Interface ==== | ==== The Author Interface ==== | ||
- | {{ http://img403.imageshack.us/img403/251/writenews.gif?nolink|Author Interface}}Number one is a user interface to write News articles, link them and define a validity period. | + | |
+ | {{ https://trello.com/ | ||
On top of it a unique anchor will be calculated to link the previewed content properly with the whole article. | On top of it a unique anchor will be calculated to link the previewed content properly with the whole article. | ||
Line 76: | Line 78: | ||
==== News Output ==== | ==== News Output ==== | ||
+ | |||
There are 3 output variants available. One is the //**News Flash**// box you can place wherever you want within your page syntax. Styling can be customized by the style.css file. The output is defined by the syntax parameters for width, quantity of articles and count of words to be previewed. | There are 3 output variants available. One is the //**News Flash**// box you can place wherever you want within your page syntax. Styling can be customized by the style.css file. The output is defined by the syntax parameters for width, quantity of articles and count of words to be previewed. | ||
Line 82: | Line 85: | ||
If you have write permission on that page where //**News Flash**// or //**All News**// syntax was placed you will find two little icons below each news article. If you click on these icons you can either edit or delete the related news post. The symbol will change from black & white picture into a colored image if you hover the mouse over it. A click on the cross will immediately delete the related news record. There is no undo function so please use this function wisely. By a click on the blue feather the section edit of the related news record will be opened. | If you have write permission on that page where //**News Flash**// or //**All News**// syntax was placed you will find two little icons below each news article. If you click on these icons you can either edit or delete the related news post. The symbol will change from black & white picture into a colored image if you hover the mouse over it. A click on the cross will immediately delete the related news record. There is no undo function so please use this function wisely. By a click on the blue feather the section edit of the related news record will be opened. | ||
- | The third method is a page as usual within | + | The third method is a page as usual within |
+ | {{https:// | ||
- | {{http:// | + | The news cloud provides you a possibility to present your news tags as links in a cloud as you may know it from the [[Cloud]] plugin. There is no dependency to install the cloud plugin for this feature. It also delivers you various options to style your cloud either by your own CSS by syntax class option and/or by styling parameters within the syntax line. The News Cloud will display all tags where you have current news articles (not beyond the perishing date). A click on such a tag-link of the News Cloud will open the configured "All News" page but overrule the potentially tag setting of the syntax line to show the current, wanted articles. |
- | + | ||
- | The news cloud provides you a possibility to present your news tags as links in a cloud as you may know it from the [[doku> | + | |
==== News Thumbshots ==== | ==== News Thumbshots ==== | ||
- | {{ http://img803.imageshack.us/img803/3550/newsthumbshots.gif}}Many of the website needs to upload the thumbshot or screenshot manually of your website. So many of them try to use the third party tool or addons to. Nowadays a lot of webmasters are looking for a website snapshot tool in order to make data presentation more attractive to their visitors. | + | |
+ | {{ https://trello.com/ | ||
The News Thumbshots are realized by integration of related online Service Providers. There you can choose from variety of the online services, fee-less or highly professional with costs. I have checked the following for you but it is not limited and may change over time (list is not under regular care and there are many more available): | The News Thumbshots are realized by integration of related online Service Providers. There you can choose from variety of the online services, fee-less or highly professional with costs. I have checked the following for you but it is not limited and may change over time (list is not under regular care and there are many more available): | ||
Line 100: | Line 103: | ||
* http:// | * http:// | ||
- | Most of them are fee of charge but need a registration of your page. The plugin does accept just one online Thumbshot provider. However, it is necessary to open the Configuration Manager and enter the related link as described on the home page (or see below). | + | Most of them are free of charge but need a registration of your page. The plugin does accept just one online Thumbshot provider. However, it is necessary to open the Configuration Manager and enter the related link as described on the home page (or see below). |
The upper mentioned 4 would lead into following configuration values. The //**%s**// parameter is mandatory as is. The plugin use this place-holder to extend the provider link by your News Page link (or whatever page you have linked). It is telling the provider from what page the thumb-shot should be taken. | The upper mentioned 4 would lead into following configuration values. The //**%s**// parameter is mandatory as is. The plugin use this place-holder to extend the provider link by your News Page link (or whatever page you have linked). It is telling the provider from what page the thumb-shot should be taken. | ||
Line 111: | Line 114: | ||
http:// | http:// | ||
</ | </ | ||
- | |||
==== Optional Configuration ==== | ==== Optional Configuration ==== | ||
- | Probably you may want to change something the please have a look into the Configuration Manager for the plugin. There are a few simple and self-explaining parameters. Further you may adapt the text used for controls and/or add further language resource files. How to do so is described within the [[Doku> | + | |
+ | Probably you may want to change something the please have a look into the Configuration Manager for the plugin. There are a few simple and self-explaining parameters. Further you may adapt the text used for controls and/or add further language resource files. How to do so is described within the [[:dokuwiki|DokuWiki.org]]. To modify the look and feel please check the style.css file. There are many definitions offered for modification. Please refer to css documentation and communities in the event of related questions. | ||
====== Plugin Configuration | ====== Plugin Configuration | ||
- | As most of the plugins this can be configured basically by use of DokuWiki [[Doku> | + | |
- | ^ Parameter ^ Effect | | + | As most of the plugins this can be configured basically by use of DokuWiki [[config|Configuration Manager]]. The news System does provide following parameter: |
- | | d_format | + | ^ Parameter |
- | | news_datafile | + | | d_format |
- | | prev_length | + | | news_datafile |
+ | | prev_length | ||
| newsflash_link | | newsflash_link | ||
- | | soapp | soapp = show one article per page (instead of current all news) | | + | | soapp |
- | | convert | + | | act_delim |
+ | | convert | ||
===== Syntax ===== | ===== Syntax ===== | ||
+ | |||
Simply place the following syntax into the page markup of a page: | Simply place the following syntax into the page markup of a page: | ||
=== Write new News === | === Write new News === | ||
+ | |||
Place the following syntax on a page to get the News author interface. The interface will be visible for all (as long as the namespace/ | Place the following syntax on a page to get the News author interface. The interface will be visible for all (as long as the namespace/ | ||
< | < | ||
=== Syntax for News preview === | === Syntax for News preview === | ||
+ | |||
Put the following syntax on a page where you want to show a preview of latest news to the visitors of your wiki. It will use the settings of config and css. | Put the following syntax on a page where you want to show a preview of latest news to the visitors of your wiki. It will use the settings of config and css. | ||
< | < | ||
Line 138: | Line 147: | ||
Some use cases may need a different preview length, box width, etc. but you want to keep the global settings ? You can modify something by using parameters. The parameters are expected on a dedicated position. The following table explaining syntax and behavior: | Some use cases may need a different preview length, box width, etc. but you want to keep the global settings ? You can modify something by using parameters. The parameters are expected on a dedicated position. The following table explaining syntax and behavior: | ||
- | ^Parameter position^Example^Description^ | + | ^ Parameter position |
- | |1|%%{{anss> | + | | 1 | %%{{anss> |
- | |2|%%{{anss> | + | | 2 | %%{{anss> |
- | |3|%%{{anss> | + | | 3 | %%{{anss> |
- | |4|%%{{anss> | + | | 4 | %%{{anss> |
- | | 5 |%%{{anss> | + | | 5 | %%{{anss> |
- | | |%%{{anss> | + | | |
=== Syntax for Read News === | === Syntax for Read News === | ||
+ | |||
Put the following syntax on a page where you want to show the complete articles of latest news to the visitors of your wiki. The articles are linked with related previews. | Put the following syntax on a page where you want to show the complete articles of latest news to the visitors of your wiki. The articles are linked with related previews. | ||
< | < | ||
- | ^Parameter position^Example^Description^ | + | ^ Parameter position |
- | | 1 |%%{{anss> | + | | 1 | %%{{anss> |
=== Syntax for Archive List === | === Syntax for Archive List === | ||
+ | |||
Put the following syntax on a page where you want to show an archive list of all news by date and headline. | Put the following syntax on a page where you want to show an archive list of all news by date and headline. | ||
< | < | ||
- | The News Archive can be invoked also by a link (e.g. __[[http:// | + | The News Archive can be invoked also by a link (e.g. [[http:// |
- | ^Parameter position^Example^Description^ | + | ^ Parameter position |
- | | **1** |%%{{anss> | + | | **1** | %%{{anss> |
- | | >1 |%%, | + | | >1 | %%,tag=...%% | Multiple tags **must not** be separated. Just write them one after the other. Tags are used as positive matching filters for the output. That means the article will be shown if one of the given tags matches the tags of an article. If no tags are given all news will be displayed. |
- | | >1 |%%, | + | | >1 | %%, |
- | | >1 |%%, | + | | >1 | %%, |
- | | >1 |%%, | + | | >1 | %%, |
- | | >1 |%%, | + | | >1 | %%, |
- | | >1 |%%, | + | | >1 | %%, |
=== Syntax for News Cloud === | === Syntax for News Cloud === | ||
+ | |||
Put the following syntax on a page where you want to show a cloud of tagged news articles. There are multiple options to style the cloud by CSS and syntax. Please read the table below carefully to get the whole set of style options. | Put the following syntax on a page where you want to show a cloud of tagged news articles. There are multiple options to style the cloud by CSS and syntax. Please read the table below carefully to get the whole set of style options. | ||
< | < | ||
- | ^Tag Alignment parameter^| | + | ^ Tag Alignment parameter |
- | |tleft | + | |tleft |
- | |tright | + | |tright |
- | |tcenter | + | |tcenter |
- | |tjustify | + | |tjustify |
- | |tinherit | + | |tinherit |
- | ^Text Transformation parameter^| | + | ^ Text Transformation parameter |
|capitalize | |capitalize | ||
- | |uppercase | + | |uppercase |
- | |lowercase | + | |lowercase |
- | ^Cloud Float parameter^| | + | ^ Cloud Float parameter |
- | |fleft | + | |fleft |
- | |fright | + | |fright |
- | |finherit | + | |finherit |
Additionally you can add '' | Additionally you can add '' | ||
+ | |||
===== Examples/ | ===== Examples/ | ||
Line 194: | Line 207: | ||
===== Development ===== | ===== Development ===== | ||
+ | |||
Each valuable help is welcome. | Each valuable help is welcome. | ||
^ Date ^ Changes | ^ Date ^ Changes | ||
- | | **2013-04-16** | **New Feature:** \\ - __[[http:// | + | | **2013-05-22** | **BugFix:** \\ [[http:// |
- | | 2013-02-19 | **New Feature:** \\ - __[[http:// | + | | 2013-04-16 |
+ | | 2013-02-19 | **New Feature:** \\ [[http:// | ||
| 2012-12-08 | Extension of Archive and Editor functionality | | | 2012-12-08 | Extension of Archive and Editor functionality | | ||
| 2012-10-17 | **New Feature:** \\ [[http:// | | 2012-10-17 | **New Feature:** \\ [[http:// | ||
Line 209: | Line 224: | ||
| 2011-03-29 | | 2011-03-29 | ||
| 2012-03-29 | | 2012-03-29 | ||
- | | 2011-03-25 | + | | 2011-03-25 |
| 2011-03-21 | | 2011-03-21 | ||
| 2011-12-07 | | 2011-12-07 | ||
Line 215: | Line 230: | ||
===== Version/ | ===== Version/ | ||
+ | |||
The plugin was tested with DW 2011-05-25 " | The plugin was tested with DW 2011-05-25 " | ||
Our standard browser is Internet Explorer 9 and FireFox 16 due to majority of users of our customers intranet installation are using this. \\ | Our standard browser is Internet Explorer 9 and FireFox 16 due to majority of users of our customers intranet installation are using this. \\ | ||
Line 226: | Line 242: | ||
* Is there a guide describing how to style the output of the plugin ? | * Is there a guide describing how to style the output of the plugin ? | ||
- | If you are interested into these or have whishes for other improvements then please register to our wiki and create a request at related | + | If you are interested into these or have whishes for other improvements then please register to our wiki and create a request at related [[http:// |
You will be automatically informed via email about each request related progress by doing so. | You will be automatically informed via email about each request related progress by doing so. | ||
Line 236: | Line 252: | ||
===== FAQ ===== | ===== FAQ ===== | ||
+ | |||
A small FAQ is provided on: [[http:// | A small FAQ is provided on: [[http:// | ||
+ | |||
===== Discussion ===== | ===== Discussion ===== | ||
- | Please use only the [[http:// | + | |
+ | Please use only the [[http:// | ||
The plugin development is still ongoing. There might be something to be corrected, to be implement or to be improved. | The plugin development is still ongoing. There might be something to be corrected, to be implement or to be improved. | ||
plugin/anewssystem.1366141408.txt.gz · Last modified: 2013-04-16 21:43 by Taggic