Articles - Revision history

Phanousk: /* Programmable Articles */

2023-05-22T08:46:43Z

Programmable Articles

← Older revision		Revision as of 04:46, 22 May 2023
Line 165:		Line 165:

	== Programmable Articles ==		== Programmable Articles ==
	If you need some programmable logic, not just a plain text, in an Article, try considering [https://metacpan.org/pod/RT::Extension::ArticleTemplates Article Templates Extension].		If you need some programmable logic not just a plain text in an Article, try considering [https://metacpan.org/pod/RT::Extension::ArticleTemplates Article Templates Extension].

Phanousk: /* Programmable Articles */

2022-03-02T13:44:51Z

Programmable Articles

← Older revision		Revision as of 09:44, 2 March 2022
Line 165:		Line 165:

	== Programmable Articles ==		== Programmable Articles ==
	If you need some programmable logic, not just a plain text, in an Article, try considering [https://metacpan.org/pod/RT::Extension::ArticleTemplates \| Article Templates Extension].		If you need some programmable logic, not just a plain text, in an Article, try considering [https://metacpan.org/pod/RT::Extension::ArticleTemplates Article Templates Extension].

Phanousk: /* Programmable Articles */

2022-03-02T13:44:36Z

Programmable Articles

← Older revision		Revision as of 09:44, 2 March 2022
Line 165:		Line 165:

	== Programmable Articles ==		== Programmable Articles ==
	If you need some programmable logic, not just a plain text, in an Article, try considering [[https://metacpan.org/pod/RT::Extension::ArticleTemplates \| Article Templates Extension]].		If you need some programmable logic, not just a plain text, in an Article, try considering [https://metacpan.org/pod/RT::Extension::ArticleTemplates \| Article Templates Extension].

Phanousk at 13:44, 2 March 2022

2022-03-02T13:44:16Z

← Older revision		Revision as of 09:44, 2 March 2022
Line 151:		Line 151:
	Ticket Create page in addition to the Reply/Comment page (Create.html		Ticket Create page in addition to the Reply/Comment page (Create.html
	in addition to Update.html)		in addition to Update.html)

	==HideArticleSearchOnReplyCreate==		==HideArticleSearchOnReplyCreate==


	On Ticket Reply (and Create if you set the above config var)		On Ticket Reply (and Create if you set the above config var)
	RTFM normally displays a search box and an include box (for		RTFM normally displays a search box and an include box (for
Line 159:		Line 158:
	of articles. These can be configured using Global Topics or		of articles. These can be configured using Global Topics or
	on the Class page.		on the Class page.


	If you set this to a true value, RTFM will only display		If you set this to a true value, RTFM will only display
	dropdowns and hide the search boxes		dropdowns and hide the search boxes

			Copied straight from RT /docs/customizing - folder

			== Programmable Articles ==
			If you need some programmable logic, not just a plain text, in an Article, try considering [[https://metacpan.org/pod/RT::Extension::ArticleTemplates \| Article Templates Extension]].

	~~Copied straight from RT~~ /~~docs~~/~~customizing - folder~~

Admin: 3 revisions imported

2016-04-06T20:03:15Z

3 revisions imported

← Older revision		Revision as of 16:03, 6 April 2016
(No difference)

78.226.57.58: /* Classes */

2014-01-03T09:34:08Z

Classes

← Older revision		Revision as of 05:34, 3 January 2014
Line 43:		Line 43:
	basis.		basis.


	~~hotlist.~~
	===Topics===		===Topics===

195.165.157.114: /* Articles */

2013-06-27T06:23:28Z

Articles

← Older revision		Revision as of 02:23, 27 June 2013
Line 3:		Line 3:

	=='''Articles '''==		=='''Articles '''==
	~~=head1 Articles~~


Line 10:		Line 9:
	be easily inserted into ticket replies or searched and browsed within		be easily inserted into ticket replies or searched and browsed within
	RT. They are organized into classes and topics.		RT. They are organized into classes and topics.
			==UI==

	=~~head2~~ UI


Line 20:		Line 17:
	on the Reply/Comment page on tickets. There are configuration variables		on the Reply/Comment page on tickets. There are configuration variables
	to make Articles available on ticket creation.		to make Articles available on ticket creation.
			==Basics==

	=~~head2~~ Basics


Line 31:		Line 26:
	Classes can be made available globally or on a per-Queue basis.		Classes can be made available globally or on a per-Queue basis.

			==Organization==
	=~~head2~~ Organization		===Classes===


	=~~head3~~ Classes


Line 53:		Line 45:

	hotlist.		hotlist.
			===Topics===

	=~~head3~~ Topics


Line 77:		Line 67:
	simply select as many topics as you desire from the list at the bottom		simply select as many topics as you desire from the list at the bottom
	of the screen.		of the screen.
			==Custom Fields==

	=~~head2~~ Custom Fields


Line 92:		Line 80:
	on "Custom Fields" and add the Custom Fields you want to each class.		on "Custom Fields" and add the Custom Fields you want to each class.
	Alternatively, use the Applies To link from each Custom Field.		Alternatively, use the Applies To link from each Custom Field.
			==Creating Articles==

	=~~head2~~ Creating Articles


Line 102:		Line 88:
	including an Article and you can control what Custom Fields end up in		including an Article and you can control what Custom Fields end up in
	your Ticket from the Class configuration page.		your Ticket from the Class configuration page.
			===Extracting an Article===

	=~~head3~~ Extracting an Article


Line 115:		Line 99:
	can pick which Custom Field that transaction should be extracted to.		can pick which Custom Field that transaction should be extracted to.
	From there on in, it's just regular article creation.		From there on in, it's just regular article creation.
			==Including an Article==

	=~~head2~~ Including an Article


Line 128:		Line 110:
	article, using the Article Hotlist and using the Queue specific		article, using the Article Hotlist and using the Queue specific
	dropdown.		dropdown.
			==Queue Specific List of Articles ==

	=~~head2~~ Queue Specific List of Articles


Line 154:		Line 134:
	Alternately, you can now implement this by applying a single class to		Alternately, you can now implement this by applying a single class to
	your queue and using the L<Article Hotlist> feature described below.		your queue and using the L<Article Hotlist> feature described below.
			==Article Hotlist==

	=~~head2~~ Article Hotlist


Line 162:		Line 140:
	reply page" option, there will be a dropdown on the Create or Update		reply page" option, there will be a dropdown on the Create or Update
	page which allows users to quickly include Articles.		page which allows users to quickly include Articles.
			==SelfService Interface==

	=~~head2~~ SelfService Interface


Line 170:		Line 146:
	will get a Search box at the top of their interface. This allows users		will get a Search box at the top of their interface. This allows users
	to look for answer to questions before creating a Ticket.		to look for answer to questions before creating a Ticket.
			=='''Configuration options'''==
			==ArticleOnTicketCreate==
	=~~head1~~ Configuration options


	=~~head2~~ ArticleOnTicketCreate


Line 181:		Line 153:
	Ticket Create page in addition to the Reply/Comment page (Create.html		Ticket Create page in addition to the Reply/Comment page (Create.html
	in addition to Update.html)		in addition to Update.html)
			==HideArticleSearchOnReplyCreate==

	=~~head2~~ HideArticleSearchOnReplyCreate


Line 197:		Line 167:


	~~=cut~~


			Copied straight from RT /docs/customizing - folder

195.165.157.114: Created page with " =='''Articles '''== =head1 Articles Articles are a way of managing stock answers or frequently asked questions. Articles are a collection of custom fields whose value..."

2013-06-27T06:18:01Z

Created page with " =='''Articles '''== =head1 Articles Articles are a way of managing stock answers or frequently asked questions. Articles are a collection of custom fields whose value..."

New page

=='''Articles '''==
=head1 Articles

Articles are a way of managing stock answers or frequently asked
questions. Articles are a collection of custom fields whose values can
be easily inserted into ticket replies or searched and browsed within
RT. They are organized into classes and topics.

=head2 UI

The user interface to Articles is available from the Tools -> Articles
menu. Admin functionality can be found under Tools -> Configuration ->
Articles. Once configured, articles will become available for searching
on the Reply/Comment page on tickets. There are configuration variables
to make Articles available on ticket creation.

=head2 Basics

You will need to make some decisions about how to organize your
articles. Articles will be organized into one Class and multiple
Topics. They will use Custom Fields to store their article data.
These Custom Fields can be configured on a Class by Class basis.
Classes can be made available globally or on a per-Queue basis.

=head2 Organization

=head3 Classes

Classes are equivalent to RT's queues. They can be created by going
to Tools -> Configuration -> Articles -> Classes -> New Class. Articles
are assigned to one Class. When you create Custom Fields for use with
Articles, they will be applied Globally or to a Class, like Custom
Fields are applied to a Queue in RT. Each class also controls what
information is included into a reply (such as the Class header and
footer) and the Article.

Classes need to be Applied, just like a Custom Field by using the
Applied To link. You can apply them globally or on a queue-by-queue
basis.

hotlist.

=head3 Topics

You can also use Topics to organize your Articles. While editing a
Class, there is a Topic tab for Class specific Topics. You can create
global Topics from the Global tab under Tools -> Configuration.

When editing Topics, type the name (and optionally description) of the
Topic, and then click the button at the appropriate location in the
Topic hierarchy. This should allow you to build a tree of Topics. This
tree of Topics should show up when creating or modifying articles in
the class. These can be arbitrarily nested.

Global Topics will be available for all Articles, regardless of their
Class. Articles can belong to both global and class-specific Topics.

Articles topics can be set from the 'Modify' screen for the article --
simply select as many topics as you desire from the list at the bottom
of the screen.

=head2 Custom Fields

Articles don't have a single "body" section for each
article. Everything is a custom field (except for name, summary and
some other basic metadata). So, you need to create some custom
fields to hold the Article body and other data. These Custom Fields
should have "Applies To" be "RTFM Articles".

Once you've created your custom fields, go into your classes and click
on "Custom Fields" and add the Custom Fields you want to each class.
Alternatively, use the Applies To link from each Custom Field.

=head2 Creating Articles

You can create an article from scratch by going to Tools -> Articles ->
New Article and then picking which Class to create the Article under.
The Summary, Description and Custom Fields will all be searchable when
including an Article and you can control what Custom Fields end up in
your Ticket from the Class configuration page.

=head3 Extracting an Article

You can extract the body of a ticket into an article. Within RT, you
should now see an "Extract to article" button in the upper right hand
corner of RT's UI when working with tickets. When you click that
button, RT will ask you which Class to create your new article in.
Once you click on a class name, the Ticket's transactions will be
displayed, along with a set of select boxes. For each transaction, you
can pick which Custom Field that transaction should be extracted to.
From there on in, it's just regular article creation.

=head2 Including an Article

When replying to or commenting on tickets or creating tickets, there
is a UI widget that lets you search for and include Articles in
your reply. (They're editable, of course).

Articles can be included by searching for them, knowing the Id of the
article, using the Article Hotlist and using the Queue specific
dropdown.

=head2 Queue Specific List of Articles

You can use Topics to organize a set of Queue specific Articles.
Simply create a global Topic called 'Queues' and then create Topics
under Queues named after each of your Queues. Within each Queue named
Topic, create some Topics and then assign Articles to those
sub-topics. This creates a hierarchy like this:

Queues
\-> General
\-> Topic 1
\-> Topic 2

If you are replying to a Ticket in the General Queue you will be
offered a choice of Topic 1 and Topic 2 along with the searching.
After choosing Topic 1 or Topic 2, you will be given a list of
relevant articles to choose.

Alternately, you can now implement this by applying a single class to
your queue and using the L<Article Hotlist> feature described below.

=head2 Article Hotlist

If you enable "All articles in this class are on dropdown on ticket
reply page" option, there will be a dropdown on the Create or Update
page which allows users to quickly include Articles.

=head2 SelfService Interface

If you grant the Unprivileged user group the right ShowArticle, they
will get a Search box at the top of their interface. This allows users
to look for answer to questions before creating a Ticket.

=head1 Configuration options

=head2 ArticleOnTicketCreate

Set this to a true value to display the Article include interface on the
Ticket Create page in addition to the Reply/Comment page (Create.html
in addition to Update.html)

=head2 HideArticleSearchOnReplyCreate

On Ticket Reply (and Create if you set the above config var)
RTFM normally displays a search box and an include box (for
inputting an article id) and configurable dropdowns
of articles. These can be configured using Global Topics or
on the Class page.

If you set this to a true value, RTFM will only display
dropdowns and hide the search boxes

=cut