1<?php
2// (c) Copyright by authors of the Tiki Wiki CMS Groupware Project
3//
4// All Rights Reserved. See copyright.txt for details and a complete list of authors.
5// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
6// $Id$
7
8function prefs_feed_list()
9{
10	return [
11		'feed_default_version' => [
12			'name' => tra('Default feed format'),
13			'type' => 'list',
14			'options' => [
15				'5' => tra('ATOM 1.0'),
16				'2' => tra('RSS 2.0'),
17			],
18			'default' => '5',
19			'shorthint' => '[https://validator.w3.org/feed/docs/atom.html|Atom 1.0]'
20						. ' - '
21						. '[http://cyber.law.harvard.edu/rss/rss.html|RSS 2.0]',
22		],
23
24		// atom specific preferences
25		'feed_atom_author_name' => [
26			'name' => tra('Feed author name'),
27			'description' => tra('Default author of each item in the feed.'),
28			'type' => 'text',
29			'size' => '40',
30			'hint' => tra('This field is mandatory unless both feed author email and homepage are empty.'),
31			'default' => '',
32		],
33		'feed_atom_author_email' => [
34			'name' => tra('Feed author email'),
35			'description' => tra('Email of the author of each item in the feed.'),
36			'type' => 'text',
37			'size' => '40',
38			'default' => '',
39		],
40		'feed_atom_author_url' => [
41			'name' => tra('Feed author homepage'),
42			'description' => tra('Homepage URL of the author of each item in the feed.'),
43			'type' => 'text',
44			'size' => '40',
45			'default' => '',
46		],
47
48		// rss specific preferences
49		'feed_rss_editor_email' => [
50			'name' => tra('Feed editor email'),
51			'description' => tra('Email address for person responsible for editorial content.'),
52			'type' => 'text',
53			'size' => '40',
54			'default' => '',
55		],
56		'feed_rss_webmaster_email' => [
57			'name' => tra('Feed webmaster email'),
58			'description' => tra('Email address for person responsible for technical issues relating to channel.'),
59			'type' => 'text',
60			'size' => '40',
61			'default' => '',
62		],
63
64		'feed_img' => [
65			'name' => tra('Feed image path'),
66			'description' => tra('Specifies a GIF, JPEG or PNG image that can be displayed with the feed.'),
67			'type' => 'text',
68			'size' => '40',
69			'default' => 'img/tiki/Tiki_WCG.png',
70		],
71		'feed_language' => [
72			'name' => tra('Feed language'),
73			'description' => tra('The default language for this feed'),
74			'type' => 'text',
75			'size' => '10',
76			'default' => 'en-us',
77			'tags' => ['basic'],
78		],
79		'feed_basic_auth' => [
80			'name' => tra('RSS basic authentication'),
81			'description' => tra('Propose basic HTTP authentication if the user has no permission to see the feed'),
82			'type' => 'flag',
83			'default' => 'n',
84		],
85		'feed_cache_time' => [
86			'name' => tra('Feed caching time'),
87			'description' => tra('Cache the feed for this number of seconds.'),
88			'type' => 'text',
89			'size' => '5',
90			'filter' => 'digits',
91			'units' => tra('seconds'),
92			'hint' => tra('Use 0 for no caching'),
93			'default' => '300', // 5 minutes
94			'detail' => tra('Feed caching is done for anonymous users only.'),
95		],
96		'feed_articles' => [
97			'name' => tra('RSS for articles'),
98			'description' => tra('RSS feeds for articles'),
99			'type' => 'flag',
100			'dependencies' => [
101				'feature_articles',
102			],
103			'default' => 'n',
104			'tags' => ['basic'],
105		],
106		'feed_blogs' => [
107			'name' => tra('RSS for blogs'),
108			'description' => tra('RSS feeds for blogs'),
109			'type' => 'flag',
110			'dependencies' => [
111				'feature_blogs',
112			],
113			'default' => 'n',
114			'tags' => ['basic'],
115		],
116		'feed_blog' => [
117			'name' => tra('RSS for individual blogs'),
118			'description' => tra('RSS feeds for individual blogs'),
119			'type' => 'flag',
120			'dependencies' => [
121				'feature_blogs',
122			],
123			'default' => 'n',
124			'tags' => ['basic'],
125		],
126		'feed_image_galleries' => [
127			'name' => tra('RSS for image galleries'),
128			'description' => tra('RSS feed for image galleries'),
129			'type' => 'flag',
130			'dependencies' => [
131				'feature_galleries',
132			],
133			'default' => 'n',
134		],
135		'feed_image_gallery' => [
136			'name' => tra('RSS for individual image galleries'),
137			'description' => tra('RSS feeds for individual image galleries'),
138			'type' => 'flag',
139			'dependencies' => [
140				'feature_galleries',
141			],
142			'default' => 'n',
143		],
144		'feed_file_galleries' => [
145			'name' => tra('RSS for file galleries'),
146			'description' => tra('RSS feed for file galleries'),
147			'type' => 'flag',
148			'dependencies' => [
149				'feature_file_galleries',
150			],
151			'default' => 'n',
152		],
153		'feed_file_gallery' => [
154			'name' => tra('RSS for individual file galleries'),
155			'description' => tra('RSS feeds for individual file galleries'),
156			'type' => 'flag',
157			'dependencies' => [
158				'feature_file_galleries',
159			],
160			'default' => 'n',
161		],
162		'feed_wiki' => [
163			'name' => tra('RSS for wiki pages'),
164			'description' => tra('RSS feed for wiki pages'),
165			'type' => 'flag',
166			'dependencies' => [
167				'feature_wiki',
168			],
169			'default' => 'n',
170		],
171		'feed_forums' => [
172			'name' => tra('RSS for forums'),
173			'description' => tra('RSS feed for forums'),
174			'type' => 'flag',
175			'dependencies' => [
176				'feature_forums',
177			],
178			'default' => 'n',
179			'tags' => ['basic'],
180		],
181		'feed_forum' => [
182			'name' => tra('RSS for individual forums'),
183			'description' => tra('RSS feeds for individual forums'),
184			'type' => 'flag',
185			'dependencies' => [
186				'feature_forums',
187			],
188			'default' => 'n',
189			'tags' => ['basic'],
190		],
191		'feed_tracker' => [
192			'name' => tra('RSS per tracker'),
193			'description' => tra('RSS feed per tracker'),
194			'type' => 'flag',
195			'dependencies' => [
196				'feature_trackers',
197			],
198			'default' => 'n',
199		],
200		'feed_calendar' => [
201			'name' => tra('RSS for calendar events'),
202			'description' => tra('RSS feed for calendar events'),
203			'type' => 'flag',
204			'dependencies' => [
205				'feature_calendar',
206			],
207			'default' => 'n',
208			'tags' => ['basic'],
209		],
210		'feed_directories' => [
211			'name' => tra('RSS for directories'),
212			'description' => tra('RSS feed for directories'),
213			'type' => 'flag',
214			'dependencies' => [
215				'feature_directory',
216			],
217			'default' => 'n',
218		],
219		'feed_shoutbox' => [
220			'name' => tra('RSS for shoutbox'),
221			'description' => tra('RSS feed for shoutbox'),
222			'type' => 'flag',
223			'dependencies' => [
224				'feature_shoutbox',
225			],
226			'default' => '',
227		],
228		'feed_articles_max' => [
229			'name' => tra('Maximum number of items to display'),
230			'type' => 'text',
231			'size' => 5,
232			'filter' => 'digits',
233			'units' => tra('items'),
234			'default' => 10,
235		],
236		'feed_blogs_max' => [
237			'name' => tra('Maximum number of items to display'),
238			'type' => 'text',
239			'size' => 5,
240			'filter' => 'digits',
241			'units' => tra('items'),
242			'default' => 10,
243		],
244		'feed_blog_max' => [
245			'name' => tra('Maximum number of items to display'),
246			'type' => 'text',
247			'size' => 5,
248			'filter' => 'digits',
249			'units' => tra('items'),
250			'default' => 10,
251		],
252		'feed_image_galleries_max' => [
253			'name' => tra('Maximum number of items to display'),
254			'type' => 'text',
255			'size' => 5,
256			'filter' => 'digits',
257			'units' => tra('items'),
258			'default' => 10,
259		],
260		'feed_image_gallery_max' => [
261			'name' => tra('Maximum number of items to display'),
262			'type' => 'text',
263			'size' => 5,
264			'filter' => 'digits',
265			'units' => tra('items'),
266			'default' => 10,
267		],
268		'feed_file_galleries_max' => [
269			'name' => tra('Maximum number of items to display'),
270			'type' => 'text',
271			'size' => 5,
272			'filter' => 'digits',
273			'units' => tra('items'),
274			'default' => 10,
275		],
276		'feed_file_gallery_max' => [
277			'name' => tra('Maximum number of items to display'),
278			'type' => 'text',
279			'size' => 5,
280			'filter' => 'digits',
281			'units' => tra('items'),
282			'default' => 10,
283		],
284		'feed_wiki_max' => [
285			'name' => tra('Maximum number of items to display'),
286			'type' => 'text',
287			'size' => 5,
288			'filter' => 'digits',
289			'units' => tra('items'),
290			'default' => 10,
291		],
292		'feed_forums_max' => [
293			'name' => tra('Maximum number of items to display'),
294			'type' => 'text',
295			'size' => 5,
296			'filter' => 'digits',
297			'units' => tra('items'),
298			'default' => 10,
299		],
300		'feed_forum_max' => [
301			'name' => tra('Maximum number of items to display'),
302			'type' => 'text',
303			'size' => 5,
304			'filter' => 'digits',
305			'units' => tra('items'),
306			'default' => 10,
307		],
308		'feed_tracker_max' => [
309			'name' => tra('Maximum number of items to display'),
310			'type' => 'text',
311			'size' => 5,
312			'filter' => 'digits',
313			'units' => tra('items'),
314			'default' => 10,
315		],
316		'feed_calendar_max' => [
317			'name' => tra('Maximum number of items to display'),
318			'type' => 'text',
319			'size' => 5,
320			'filter' => 'digits',
321			'units' => tra('items'),
322			'default' => 10,
323		],
324		'feed_directories_max' => [
325			'name' => tra('Maximum number of items to display'),
326			'type' => 'text',
327			'size' => 5,
328			'filter' => 'digits',
329			'units' => tra('items'),
330			'default' => 10,
331		],
332		'feed_shoutbox_max' => [
333			'name' => tra('Maximum number of items to display'),
334			'type' => 'text',
335			'size' => 5,
336			'filter' => 'digits',
337			'units' => tra('items'),
338			'default' => '',
339		],
340		'feed_articles_showAuthor' => [
341			'name' => tra('Show author'),
342			'type' => 'flag',
343			'default' => 'n',
344		],
345		'feed_blogs_showAuthor' => [
346			'name' => tra('Show author'),
347			'type' => 'flag',
348			'default' => 'n',
349		],
350		'feed_blog_showAuthor' => [
351			'name' => tra('Show author'),
352			'type' => 'flag',
353			'default' => 'n',
354		],
355		'feed_image_galleries_showAuthor' => [
356			'name' => tra('Show author'),
357			'type' => 'flag',
358			'default' => 'n',
359		],
360		'feed_image_gallery_showAuthor' => [
361			'name' => tra('Show author'),
362			'type' => 'flag',
363			'default' => 'n',
364		],
365		'feed_file_galleries_showAuthor' => [
366			'name' => tra('Show author'),
367			'type' => 'flag',
368			'default' => 'n',
369		],
370		'feed_file_gallery_showAuthor' => [
371			'name' => tra('Show author'),
372			'type' => 'flag',
373			'default' => 'n',
374		],
375		'feed_wiki_showAuthor' => [
376			'name' => tra('Show author'),
377			'type' => 'flag',
378			'default' => 'n',
379		],
380		'feed_forums_showAuthor' => [
381			'name' => tra('Show author'),
382			'type' => 'flag',
383			'default' => 'n',
384		],
385		'feed_forum_showAuthor' => [
386			'name' => tra('Show author'),
387			'type' => 'flag',
388			'default' => 'n',
389		],
390		'feed_tracker_showAuthor' => [
391			'name' => tra('Show author'),
392			'type' => 'flag',
393			'default' => 'n',
394		],
395		'feed_calendar_showAuthor' => [
396			'name' => tra('Show author'),
397			'type' => 'flag',
398			'default' => 'n',
399		],
400		'feed_directories_showAuthor' => [
401			'name' => tra('Show author'),
402			'type' => 'flag',
403			'default' => 'n',
404		],
405		'feed_shoutbox_showAuthor' => [
406			'name' => tra('Show author'),
407			'type' => 'flag',
408			'default' => 'n',
409		],
410		'feed_articles_homepage' => [
411			'name' => tra('Homepage URL'),
412			'type' => 'text',
413			'size' => '60',
414			'default' => '',
415		],
416		'feed_blogs_homepage' => [
417			'name' => tra('Homepage URL'),
418			'type' => 'text',
419			'size' => '60',
420			'default' => '',
421		],
422		'feed_blog_homepage' => [
423			'name' => tra('Homepage URL'),
424			'type' => 'text',
425			'size' => '60',
426			'default' => '',
427		],
428		'feed_image_galleries_homepage' => [
429			'name' => tra('Homepage URL'),
430			'type' => 'text',
431			'size' => '60',
432			'default' => '',
433		],
434		'feed_image_gallery_homepage' => [
435			'name' => tra('Homepage URL'),
436			'type' => 'text',
437			'size' => '60',
438			'default' => '',
439		],
440		'feed_file_galleries_homepage' => [
441			'name' => tra('Homepage URL'),
442			'type' => 'text',
443			'size' => '60',
444			'default' => '',
445		],
446		'feed_file_gallery_homepage' => [
447			'name' => tra('Homepage URL'),
448			'type' => 'text',
449			'size' => '60',
450			'default' => '',
451		],
452		'feed_wiki_homepage' => [
453			'name' => tra('Homepage URL'),
454			'type' => 'text',
455			'size' => '60',
456			'default' => '',
457		],
458		'feed_forum_homepage' => [
459			'name' => tra('Homepage URL'),
460			'type' => 'text',
461			'size' => '60',
462			'default' => '',
463		],
464		'feed_tracker_homepage' => [
465			'name' => tra('Homepage URL'),
466			'type' => 'text',
467			'size' => '60',
468			'default' => '',
469		],
470		'feed_calendar_homepage' => [
471			'name' => tra('Homepage URL'),
472			'type' => 'text',
473			'size' => '60',
474			'default' => '',
475		],
476		'feed_directories_homepage' => [
477			'name' => tra('Homepage URL'),
478			'type' => 'text',
479			'size' => '60',
480			'default' => '',
481		],
482		'feed_shoutbox_homepage' => [
483			'name' => tra('Homepage URL'),
484			'type' => 'text',
485			'size' => '60',
486			'default' => '',
487		],
488		'feed_articles_title' => [
489			'name' => tra('Title'),
490			'type' => 'text',
491			'size' => '80',
492			'default' => tra('Tiki RSS feed for articles'),
493		],
494		'feed_blogs_title' => [
495			'name' => tra('Title'),
496			'type' => 'text',
497			'size' => '80',
498			'default' => tra('Tiki RSS feed for blogs'),
499		],
500		'feed_blog_title' => [
501			'name' => tra('Title'),
502			'description' => tra('Title to be prepended to the blog title for all blogs. If this field is empty only the blog title will be used.'),
503			'type' => 'text',
504			'size' => '80',
505			'default' => '',
506		],
507		'feed_image_galleries_title' => [
508			'name' => tra('Title'),
509			'type' => 'text',
510			'size' => '80',
511			'default' => tra('Tiki RSS feed for image galleries'),
512		],
513		'feed_image_gallery_title' => [
514			'name' => tra('Title'),
515			'type' => 'text',
516			'size' => '80',
517			'default' => tra('Tiki RSS feed for the image gallery: '),
518		],
519		'feed_file_galleries_title' => [
520			'name' => tra('Title'),
521			'type' => 'text',
522			'size' => '80',
523			'default' => tra('Tiki RSS feed for file galleries'),
524		],
525		'feed_file_gallery_title' => [
526			'name' => tra('Title'),
527			'type' => 'text',
528			'size' => '80',
529			'default' => tra('Tiki RSS feed for the file gallery: '),
530		],
531		'feed_wiki_title' => [
532			'name' => tra('Title'),
533			'type' => 'text',
534			'size' => '80',
535			'default' => tra('Tiki RSS feed for the wiki pages'),
536		],
537		'feed_forums_title' => [
538			'name' => tra('Title'),
539			'type' => 'text',
540			'size' => '80',
541			'default' => tra('Tiki RSS feed for forums'),
542		],
543		'feed_forum_title' => [
544			'name' => tra('Title'),
545			'type' => 'text',
546			'size' => '80',
547			'default' => tra('Tiki RSS feed for forum: '),
548		],
549		'feed_tracker_title' => [
550			'name' => tra('Title'),
551			'type' => 'text',
552			'size' => '80',
553			'default' => tra('Tiki RSS feed for individual trackers: '),
554		],
555		'feed_calendar_title' => [
556			'name' => tra('Title'),
557			'type' => 'text',
558			'size' => '80',
559			'default' => tra('Tiki RSS feed for calendars'),
560		],
561		'feed_directories_title' => [
562			'name' => tra('Title'),
563			'type' => 'text',
564			'size' => '80',
565			'default' => tra('Tiki RSS feed for directory sites'),
566		],
567		'feed_shoutbox_title' => [
568			'name' => tra('Title'),
569			'type' => 'text',
570			'size' => '80',
571			'default' => tra('Tiki RSS feed for shoutbox messages'),
572		],
573		'feed_articles_desc' => [
574			'name' => tra('Article RSS description'),
575			'description' => tra('Description to be published as part of the RSS feed for articles.'),
576			'type' => 'textarea',
577			'size' => 2,
578			'default' => tra('Last articles.'),
579		],
580		'feed_blogs_desc' => [
581			'name' => tra('Blogs RSS description'),
582			'description' => tra('Description to be published as part of the RSS feed for blogs.'),
583			'type' => 'textarea',
584			'size' => 2,
585			'default' => tra('Last posts to weblogs.'),
586		],
587		'feed_blog_desc' => [
588			'name' => tra('Blog RSS Description'),
589			'description' => tra('Description to be prepended to the blog description and published as part of the RSS feeds for individual blogs. If this field is empty, the blog description only will be used.'),
590			'type' => 'textarea',
591			'size' => 2,
592			'default' => '',
593		],
594		'feed_image_galleries_desc' => [
595			'name' => tra('Image galleries RSS description'),
596			'description' => tra('Description to be published as part of the RSS feed for image galleries.'),
597			'type' => 'textarea',
598			'size' => 2,
599			'default' => tra('Latest images uploaded to the image galleries.'),
600		],
601		'feed_image_gallery_desc' => [
602			'name' => tra('Individual image galleries RSS Description'),
603			'description' => tra('Description to be published as part of the RSS feeds for individual image galleries.'),
604			'type' => 'textarea',
605			'size' => 2,
606			'default' => tra('Latest images uploaded to this image gallery.'),
607		],
608		'feed_file_galleries_desc' => [
609			'name' => tra('File galleries RSS description'),
610			'description' => tra('Description to be published as part of the RSS feed for file galleries.'),
611			'type' => 'textarea',
612			'size' => 2,
613			'default' => tra('Latest files uploaded to the file galleries.'),
614		],
615		'feed_file_gallery_desc' => [
616			'name' => tra('Individual file galleries RSS description'),
617			'description' => tra('Description to be published as part of the RSS feeds for individual file galleries.'),
618			'type' => 'textarea',
619			'size' => 2,
620			'default' => tra('Latest files uploaded to this file gallery.'),
621		],
622		'feed_wiki_desc' => [
623			'name' => tra('Wiki pages RSS description'),
624			'description' => tra('Description to be published as part of the RSS feed for wiki pages pages.'),
625			'type' => 'textarea',
626			'size' => 2,
627			'default' => tra('Latest wiki page changes.'),
628		],
629		'feed_forums_desc' => [
630			'name' => tra('Forums RSS description'),
631			'description' => tra('Description to be published as part of the RSS feed for forums.'),
632			'type' => 'textarea',
633			'size' => 2,
634			'default' => tra('Latest forum topics.'),
635		],
636		'feed_forum_desc' => [
637			'name' => tra('Individual forums RSS description'),
638			'description' => tra('Description to be published as part of the RSS feeds for individual forums.'),
639			'type' => 'textarea',
640			'size' => 2,
641			'default' => tra('Latest posts to this form'),
642		],
643		'feed_tracker_desc' => [
644			'name' => tra('Individual trackers RSS description'),
645			'description' => tra('Description to be published as part of the RSS feed for individual trackers.'),
646			'type' => 'textarea',
647			'size' => 2,
648			'default' => tra('Latest additions to this tracker.'),
649		],
650		'feed_calendar_desc' => [
651			'name' => tra('Calendar events RSS description'),
652			'description' => tra('Description to be published as part of the RSS feed for calendar events.'),
653			'type' => 'textarea',
654			'size' => 2,
655			'default' => tra('Upcoming Events.'),
656		],
657		'feed_directories_desc' => [
658			'name' => tra('Directories RSS description'),
659			'description' => tra('Description to be published as part of the RSS feed for directories.'),
660			'type' => 'textarea',
661			'size' => 2,
662			'default' => tra('Latest sites.'),
663		],
664		'feed_shoutbox_desc' => [
665			'name' => tra('Shoutbox RSS description'),
666			'description' => tra('Description to be published as part of the RSS feed for shoutbox messages.'),
667			'type' => 'textarea',
668			'size' => 2,
669			'default' => tra('Latest shoutbox messages.'),
670		],
671		'feed_tracker_labels' => [
672			'name' => tra('Tracker labels'),
673			'description' => tra('Include tracker field labels in the RSS output'),
674			'type' => 'flag',
675			'dependencies' => [
676				'feature_trackers',
677			],
678			'default' => 'y',
679		],
680		'feed_forums_homepage' => [
681			'name' => tra('Homepage URL'),
682			'type' => 'text',
683			'size' => '60',
684			'default' => '',
685		],
686	];
687}
688