[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: [OASIS Issue Tracker] Created: (ODATA-178) Enhance abstract, distinguish its content from 1st paragraph of introduction and edit the payload object listing in 2nd para of 1 Introduction
Enhance abstract, distinguish its content from 1st paragraph of introduction and edit the payload object listing in 2nd para of 1 Introduction
----------------------------------------------------------------------------------------------------------------------------------------------
Key: ODATA-178
URL: http://tools.oasis-open.org/issues/browse/ODATA-178
Project: OASIS Open Data Protocol (OData) TC
Issue Type: Improvement
Components: OData ATOM Format v1.0
Affects Versions: WD01
Reporter: Stefan Drees
Priority: Trivial
Fix For: WD01
In the current reviion of the workproduct [odata-atom-format-v1.0-wd01-2012-11-27.doc](https://www.oasis-open.org/committees/download.php/47557/odata-atom-format-v1.0-wd01-2012-11-27.doc) the abstract reads:
"""
The OData protocol is comprised of a set of specifications for representing and interacting with structured content. This document describes the OData Atom Format returned from an OData Service when requesting the application/atom+xml mime type.
"""
with the terms 'application/atom+xml' formated in a different way (presumably to show this is a special token). The introduction (section 1 on page 6 of 37 in PDF-A4-Output) starts with (identical text):
"""
The OData protocol is comprised of a set of specifications for representing and interacting with structured content. This document describes the OData Atom Format returned from an OData Service when requesting the application/atom+xml mime type.
"""
I think we should avoid this. An abstract condenses the content of the document regardless of reader knowledge or presentation sequence. It has a passive function saying: "this is what i am". The reader is active and may decide to continue or not.
The introduction is reader oriented and adapts for the presentation sequence in the remaining document. It tells what the author expects as prerequisites from the reader, may offer a guiding line and in summary helps the imagined reader to a good start into the subject i.e. here the rest of the document.
Also I discourage usage of special formating in abstracts, (as with the mime type token in this case).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]