Article View Module

Version 1.0

Description

Article View Objects - Allow you to choose different ways of viewing objects in different page layouts

Configuration

Below are the list of settings that the user can choose from for each configured data object of the Article View Module module.

Configurable Settings
Number Configurable Variable Description Input Type Input Rules
1 Name The Name of this Article View Module. - This will also appear as the HTML title on top of the browser and will appear as part of the page title in search engine listings - keep it short and meaningful! text Mandatory Field. Plain Text Only.
2 Description A short description of this Article View Module. - This will be added into the HTML meta tag for the page in question and is important for search engines, so use several specifically descriptive words that match the content of the object. This will also appear on the management screens for this site. It is a good idea to give a brief description which will enable you to quickly identify which entries are which in lists of objects. textarea Mandatory Field. Plain Text Only.
3 Image An icon file associated with this Article View Module. - This allows you to link to the Article View Module with an image instead of a text string. Enter the name of a valid local file. text Optional Field. Plain Text Only.
Article View Module Basic Information
4 Page Title The title that appears on top of the Article view page text Optional Field. Plain Text Only.
5 Article Notice Allows you to make a piece of html appear at the top of every article page - Can be useful to advertise important events textarea Optional Field. HTML / PHP input allowed.
6 Article End Note Allows you to make a piece of html appear at the bottom of every article viewed with this module - Can be useful to advertise important events textarea Optional Field. HTML / PHP input allowed.
Editors view of Article View Page
These settings govern what the editor can see on the article view pages
7 Show Hidden Stories Should Hidden Stories be highlighted for editors? - This setting allows editors to see hidden stories on the newswire page. checkbox On / Off
8 Show Locked Stories Should Locked Stories be highlighted for editors? - This setting allows editors to see locked stories on the newswire page. checkbox On / Off
9 Show Sticky Stories Should Sticky Stories be highlighted for editors? - This setting allows editors to see sticky stories on the newswire page. checkbox On / Off
10 Use Status Icons Should Hidden and locked Stories use icons instead of text? - This setting allows editors to see hidden stories on this newswire. checkbox On / Off
Editing of Multiple Comments on Article View Page
11 Unstick Should Editors be able to unstick multiple articles at once? - This setting makes it easier for editors to do their work, but can also make it easier for malicious users to do damage if they can get access. If you trust your editors and are happy with your security, you can comfortably check this box checkbox On / Off
12 Hide Should Editors be able to hide multiple articles at once? - This setting makes it easier for editors to do their work, but can also make it easier for malicious users to do damage if they can get access. If you trust your editors and are happy with your security, you can comfortably check this box checkbox On / Off
13 Unhide Should Editors be able to unhide multiple articles at once? - This setting makes it easier for editors to do their work, but can also make it easier for malicious users to do damage if they can get access. If you trust your editors and are happy with your security, you can comfortably check this box checkbox On / Off
Basic Page Settings
14 Show Comments Should Comments be viewable with stories? - This setting means that comments will be visible with the stories checkbox On / Off
15 Comments per page Number of comments to display by default on article page (0 for show all) - How many articles should be displayed at a time on the comments page (1-99)? select Numeric Option between: 0 and 300
16 Condense Comments Should only the comment titles be visible? - This setting means that only the titles of comments will be visible to the public. checkbox On / Off
17 Comment Order What order should comments be displayed in? - Latest first or oldest first? radio Options: desc, asc
Page Header Navigation Settings
18 Other Modules Links? Show links to the other modules of the site for alternative views? - This setting governs what navigation will appear on the top of the newswire column. checkbox On / Off
Page Footer Navigation Settings
19 Other Modules Links? Show links to the other modules of the site for alternative views? - This setting governs what navigation will appear at the bottom of the newswire column. checkbox On / Off
Article Presentation Settings
20 Story Date Format Input the date format string (strftime format) - see strftime manual page text Optional Field. Plain Text Only.
21 Comment Date Format Input the date format string (strftime format) - see strftime manual page text Optional Field. Plain Text Only.
22 Event Date Format Input the date format string (strftime format) - see strftime manual page text Optional Field. Plain Text Only.
23 Story Context Show story context in the article summary? - Choose where you want the context to appear radio Options: subtitle, end, both, neither
24 Story Date Show story date in the article summary? - Choose where you want the date to appear radio Options: subtitle, end, both, neither
25 Story Author Show story author? - Choose where you want the author to appear radio Options: subtitle, end, both, neither
26 Author Contact Details? Show author's contact details? - Choose where you want the details to appear radio Options: subtitle, end, both, neither
27 Story Attachments Show story attachment information in the story summary? - Choose where you want the information to appear radio Options: subtitle, end, both, neither
28 Show Related Link Show Related Link in the newswire summary - This setting governs whether the related link in stories appear in the summary. checkbox On / Off
29 Related Link Text The text introduction to the related link - try "Related Link" text Optional Field. Plain Text Only.
Image Presentation Settings
30 Resize Height Resize the picture to this height in pixels (0 for no resize) - Resizing images on article views allows you to let users upload large images and replace them with smaller ones for display select Numeric Option between: 0 and 1000
31 Resize Width Resize the picture to this width in pixels (0 for no resize) select Numeric Option between: 0 and 1000
32 Maximum Filesize Resize the picture file if it is over this size (KB) (0 for no resize) select Numeric Option between: 0 and 1000
33 Link to Full Link to a full-sized version of the image when resized? - If you do this, people will still be able to find the large versions easily and this may affect your bandwidth checkbox On / Off
Links And Relationships
links from this module to other modules on the site
34 Page Layout The Layout of the article Page reference A reference to a data object of type page
35 Publish Module The publishing module for writing comments on this article reference A reference to a data object of type publish
36 Newswire Module The newswire module linked to by this article view (choose none to use primary site newswire) reference A reference to a data object of type newswire
37 Report Form The Contact form which users can use to inform editors of abusive posts - leave unassigned if you do not want to use this feature reference A reference to a data object of type contact
38 Report Form The exported feed which users can use to track comments on an article - leave unassigned if you do not want to use this feature reference A reference to a data object of type feedexport
User Messages
39 Failure Message The message that will be displayed to the user when no document is found to match their query - Try: "Document Not Available" textarea Mandatory Field. HTML / PHP input allowed.
40 Hidden Message The message that will be displayed to the user when they attempt to view a hidden document - Try "Sorry, this story has been removed due to a possible breach of the editorial guidelines and is under review by the Editorial Group!" textarea Mandatory Field. HTML / PHP input allowed.
41 Not Viewable Message The message that will be displayed to the user when they attempt to view a filtered-out document - Try "Sorry, this document can't be viewed in this part of the site!" textarea Mandatory Field. HTML / PHP input allowed.
42 Locked Message The message that will be displayed to the user when they view a locked document - Try "This Story has been locked due to abuse. No Further comments are being accepted at the moment." textarea Mandatory Field. HTML / PHP input allowed.
43 No Story Message The error message that will be displayed to the user when do not specify an article Id to view - Try "you need to specify an id of a story to view!" textarea Mandatory Field. HTML / PHP input allowed.
44 Hidden Comments The message that tells the user that there are hidden comments on this thread - Try "some comments on this thread have been hidden" textarea Optional Field. HTML / PHP input allowed.
User Text Snippets
45 Add Comment Message The message that will be displayed to the user to invite them to add a comment to an article - Try "Add your comments" text Mandatory Field. HTML / PHP input allowed.
46 Back To Article Message The message that will be displayed to the user to invite them to return to the story when viewing a comment - Try "back to story" text Mandatory Field. HTML / PHP input allowed.
47 Back To Newswire Message The message that will be displayed to the user to invite them to return to the newswire when viewing a story - Try "back to story" text Mandatory Field. HTML / PHP input allowed.
48 Titles only Message The message that will be displayed to the user to invite them to view only the titles of comments - Try "show comment titles only" text Mandatory Field. HTML / PHP input allowed.
49 Full Comments Message The message that will be displayed to the user to invite them to view the full content of comments - Try "show full comment content" text Mandatory Field. HTML / PHP input allowed.
50 Oldest First Message The message that will be displayed to the user to invite them to view the oldest comments first - Try "show oldest comments first" text Mandatory Field. HTML / PHP input allowed.
51 Latest First Message The message that will be displayed to the user to invite them to view the most recent comments first - Try "show latest comments first" text Mandatory Field. HTML / PHP input allowed.
52 Comments Section Title The title of the comments section. - Try "Comments" text Mandatory Field. HTML / PHP input allowed.
53 Page Navigation Text The text that links to following pages of comments - Try "Go To Page: " text Mandatory Field. HTML / PHP input allowed.
54 Comments Page Size Text The text that invitest the user to set the page size - Try "Number of comments per page" text Mandatory Field. HTML / PHP input allowed.
55 Comment Navigation Text The text that links to particular comments - Try "Jump To Comment: " text Mandatory Field. HTML / PHP input allowed.
Attachment Messages
56 Editor Note The text that introduces a note to the editor - Try "Note To Editor" text Mandatory Field. HTML / PHP input allowed.
57 Self Link Message The editor warning that will be displayed when a article contains a link to its own attachment textarea Mandatory Field. HTML / PHP input allowed.
58 External Image The editor warning that will be displayed to to warn about external images being attached to stories - Try "External Image Warning: this story contains a link to an image that is not attached to the story" textarea Mandatory Field. HTML / PHP input allowed.
59 Hidden Attachments The editor warning that will be displayed to to warn about hidden attachments being referenced in the html content - Try "Hidden Attachment Warning" textarea Mandatory Field. HTML / PHP input allowed.
60 Fix text The text that invites the editor to fix an external link - Try "FIX:" text Mandatory Field. HTML / PHP input allowed.
61 Original Reference Text The original reference text - Try "Original Reference" text Mandatory Field. HTML / PHP input allowed.
62 Copy and Unhide Fix Text The text inviting the editor to copy and unhide to fix - Try "Original Reference" text Mandatory Field. HTML / PHP input allowed.
63 Copy Fix Text The text inviting the editor to copy to fix - Try "Original Reference" text Mandatory Field. HTML / PHP input allowed.
64 Create Fix Text The text inviting the editor to create a new attachment to fix - Try "Original Reference" text Mandatory Field. HTML / PHP input allowed.
65 Unhide Fix Text The text inviting the editor to unhide attachment to fix - Try "Unhide to fix" text Mandatory Field. HTML / PHP input allowed.
66 Can't Fix Text The text instructing the editor that there are insufficent permissions to fix - Try "You have insufficent permissions to fix this problem" text Mandatory Field. HTML / PHP input allowed.
67 Manual Fix Text The text indicating that a manual fix is required - Try "manual fix required" text Mandatory Field. HTML / PHP input allowed.
68 Fix Explanation Text The text explaining to the editor why a fix is required - Try "External Image Warning: this story contains a link to an image that is not attached to the story" textarea Mandatory Field. HTML / PHP input allowed.
69 Hidden Explanation Text The text explaining to the editor why a fix is required for hidden attachments - ... textarea Mandatory Field. HTML / PHP input allowed.
70 Report Post Text The text inviting a user to report an abusive mail - Try "report this post" text Mandatory Field. HTML / PHP input allowed.
71 Report Post Subject The subject line of mails to the editorial group reporting a post - Try "Abusive Post Report:" text Mandatory Field. HTML / PHP input allowed.
72 RSS explanation The help text that tells a user how to use the RSS feed - Try "Abusive Post Report:" textarea Mandatory Field. HTML / PHP input allowed.
73 RSS Text The text beside the rss icon - Try "Abusive Post Report:" text Mandatory Field. HTML / PHP input allowed.
74 Atom Text The text beside the atom icon - Try "Atom feed" text Mandatory Field. HTML / PHP input allowed.
Access Control for this Article View Module
Protect this Article View Module from unauthorised users and from being used in other sections of the site
75 Protected Should This Article View Module be hidden from the public? - Check this box if you want this Article View Module to be only visible to editors on the site. This can be useful for keeping certain pages hidden from public view. checkbox On / Off
76 Shared? Should This Article View Module be available to add to menus etc on other sections of this site? - Shared Data Objects can be added to menus, lists, pages and so on throughout the site, no matter what section the page that includes them is from. Objects that are not shared are only available within the site section where they are owned. checkbox On / Off

Display Modes

  1. Full Page

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006
Topic revision: r2 - 09 Jan 2006, ChekovFeeney
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback