Bug 1036964

Summary:	RFE: Include additional Abstract functionality
Product:	[Community] PressGang CCMS	Reporter:	Lee Newson <lnewson>
Component:	Documentation	Assignee:	Jared MORGAN <jmorgan>
Status:	CLOSED CURRENTRELEASE	QA Contact:
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	1.3	CC:	mmurray
Target Milestone:	---	Keywords:	Documentation
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:	Build Name: 13968, PressGang CCMS Handbook-2.0-1 Build Date: 02-12-2013 18:39:02 Topic ID: 23492-551373 [Latest]
Last Closed:	2015-05-06 05:49:24 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Lee Newson 2013-12-03 01:07:34 UTC

In 1.3 the ability to create abstract topics to handle more complex abstracts was added.

To define a Abstract topic you should either create the Abstract topic via a Content Specification. eg:

Abstract = [N, Abstract, writer=lnewson]

or create a topic normally and make sure it is tagged with the "Abstract" topic type found in the the Common -> Topic Types project/category.

Comment 1 Lee Newson 2013-12-03 01:38:39 UTC

Just adding that some more information that I forgot.

The metadata key is the same for abstract topics or just plain text. eg:

Abstract Topic:

Abstract = [1234]

XML for the above topic:

<abstract>
  <para>
    This is the first paragraph in a complex abstract.
  </para>
  <para>
    This is the second paragraph in a complex abstract.
  </para>
</abstract>

Plain Text Abstract:

Abstract = This is a simple abstract using only plain text.

It's also worth noting that simple abstract is normally wrapped in a <para>, however you can change this by including the xml element around the simple abstract text. eg:

Abstract = <simpara>This is a simple abstract using only plain text.</simpara>

Comment 2 Lee Newson 2013-12-03 01:39:44 UTC

See BZ#1014455 for the RFE to implement this.

Comment 3 Jared MORGAN 2013-12-05 02:37:55 UTC

New Abstract Methods appended to Topic 23492.

Ready for QE.

Comment 4 Lee Newson 2013-12-11 04:33:28 UTC

Looks good thanks Jared, however in the complex abstract section it doesn't mention that the Abstract topic must be tagged with "Abstract" topic type. Without that bit of information I believe that users might wonder why it isn't working by just trying to use a regular topic.

Maybe we could just copy the Author_Group.xml (topic 24451) content and adjust it for the complex abstract section?

Comment 5 Jared MORGAN 2013-12-11 05:53:13 UTC

(In reply to Lee Newson from comment #4)
> Looks good thanks Jared, however in the complex abstract section it doesn't
> mention that the Abstract topic must be tagged with "Abstract" topic type.
> Without that bit of information I believe that users might wonder why it
> isn't working by just trying to use a regular topic.
> 
> Maybe we could just copy the Author_Group.xml (topic 24451) content and
> adjust it for the complex abstract section?

Thanks mate. I've just made that change to the existing topic for now.

Comment 6 Lee Newson 2013-12-11 05:58:10 UTC

Perfect, thanks Jared.