Generic document structure objects - Revision history

Admin at 21:15, 19 May 2010

2010-05-19T21:15:12Z

← Older revision		Revision as of 14:15, 19 May 2010
Line 46:		Line 46:

	Object types:		Object types:
	~~-------------~~		*Document: contains information about the entire document and points to contained Sections (as pre-matter, main body, and appendices).
	Document: contains information about the entire document and points to contained Sections (as pre-matter, main body, and appendices).		*Section: Contains content in the form of Paragraphs, Figures, Tables, Code Fragments, Equations.
	Section: Contains content in the form of Paragraphs, Figures, Tables, Code Fragments, Equations.		*Paragraph: Contains text content.
	Paragraph: Contains text content.		*Figure: Contains image content.
	Figure: Contains image content.		*Table: Contains tabular format (data).
	Table: Contains tabular format (data).		*Code: Contains code listings.
	Code: Contains code listings.		*Equation: Contains non-inline TeX equations (or mathml I suppose).
	Equation: Contains non-inline TeX equations (or mathml I suppose).

	For each item, it could contain verbatim text, formatted text, data, image blobs, URIs to find the information, etc., as appropriate for the type.		For each item, it could contain verbatim text, formatted text, data, image blobs, URIs to find the information, etc., as appropriate for the type.

	Most of these objects have id fields, specifying a way to refer to the given section, figure, etc.		*Most of these objects have id fields, specifying a way to refer to the given section, figure, etc.
	Most have title fields, which would be used to identify the section, etc, in tables of contents, figures, bibliographies, etc., as well as titles in the section text itself.		*Most have title fields, which would be used to identify the section, etc, in tables of contents, figures, bibliographies, etc., as well as titles in the section text itself.
	A url field may be present which would be used to get the data for the section.		*A url field may be present which would be used to get the data for the section.
	Alternatively, a blob field could be present, where the section's data would be directly included in the data structure.		*Alternatively, a blob field could be present, where the section's data would be directly included in the data structure.
	If either the url or blob field is present, a type field would specify how to interpret the data at the URL, or the data in the blob. The default type depends on the type of object and the fields that the data is in.		*If either the url or blob field is present, a type field would specify how to interpret the data at the URL, or the data in the blob. The default type depends on the type of object and the fields that the data is in.
	Some objects may have caption fields to show by the figure/table/etc.		*Some objects may have caption fields to show by the figure/table/etc.
	Some objects may contain other fields to represent the data in a different way.		*Some objects may contain other fields to represent the data in a different way.

Admin at 21:14, 19 May 2010

2010-05-19T21:14:09Z

← Older revision		Revision as of 14:14, 19 May 2010
Line 20:		Line 20:

	*strikethrough text		*strikethrough text
	<s> tags for XHTML? </s>		<s> tags for XHTML </s>

	*monospaced text		*monospaced text
Line 32:		Line 32:

	*description lists		*description lists
	<dd> tags in XHTML </dd>		<dl> tags in XHTML </dl>

	*tex inline math		*tex inline math

Admin at 21:13, 19 May 2010

2010-05-19T21:13:07Z

← Older revision		Revision as of 14:13, 19 May 2010
Line 11:		Line 11:

	*bold text		*bold text
	<b> tags for XHTML		<b> tags for XHTML </b>

	*italic text		*italic text
	<i> tags for XHTML		<i> tags for XHTML </i>

	*underline text		*underline text
	<u> tags for XHTML		<u> tags for XHTML </u>

	*strikethrough text		*strikethrough text
	<s> tags for XHTML?		<s> tags for XHTML? </s>

	*monospaced text		*monospaced text
	<m> tags for XHMTL?		<m> tags for XHMTL? </m>

	*enumerated lists		*enumerated lists
	<ol> tags in XHTML		<ol> tags in XHTML </ol>

	*itemized lists		*itemized lists
	<ul> tags in XHTML		<ul> tags in XHTML </ul>

	*description lists		*description lists
	<dd> tags in XHTML		<dd> tags in XHTML </dd>

	*tex inline math		*tex inline math

Admin: Created page with 'Two parts: data structures representing the document structure text formatting It's important to keep the distinction between the two. Representations for the first are indep…'

2010-05-19T21:12:09Z

Created page with 'Two parts: *data structures representing the document structure *text formatting It's important to keep the distinction between the two. Representations for the first are indep…'

New page

Two parts:
*data structures representing the document structure
*text formatting

It's important to keep the distinction between the two. Representations for the first are independant of representations for the second.

I'd like the first (data structures) to be something that can easily and directly translate between languages, container formats, databases, etc.
The second (formating) should primarily be unified across all data structure types and formats, but there might be alternative representations for XHTML.

We can address the formatting first:

*bold text
<b> tags for XHTML

*italic text
<i> tags for XHTML

*underline text
<u> tags for XHTML

*strikethrough text
<s> tags for XHTML?

*monospaced text
<m> tags for XHMTL?

*enumerated lists
<ol> tags in XHTML

*itemized lists
<ul> tags in XHTML

*description lists
<dd> tags in XHTML

*tex inline math
$ "tag" in TeX

*references (both internal and external)

Ensure that we allow unicode characters and maybe XHTML character entities?

The data structure should be easy to put into YAML, JSON, XML. It should be directly representable by nested hashes and arrays in javascript and perl.

Object types:
-------------
Document: contains information about the entire document and points to contained Sections (as pre-matter, main body, and appendices).
Section: Contains content in the form of Paragraphs, Figures, Tables, Code Fragments, Equations.
Paragraph: Contains text content.
Figure: Contains image content.
Table: Contains tabular format (data).
Code: Contains code listings.
Equation: Contains non-inline TeX equations (or mathml I suppose).

For each item, it could contain verbatim text, formatted text, data, image blobs, URIs to find the information, etc., as appropriate for the type.

Most of these objects have id fields, specifying a way to refer to the given section, figure, etc.
Most have title fields, which would be used to identify the section, etc, in tables of contents, figures, bibliographies, etc., as well as titles in the section text itself.
A url field may be present which would be used to get the data for the section.
Alternatively, a blob field could be present, where the section's data would be directly included in the data structure.
If either the url or blob field is present, a type field would specify how to interpret the data at the URL, or the data in the blob. The default type depends on the type of object and the fields that the data is in.
Some objects may have caption fields to show by the figure/table/etc.
Some objects may contain other fields to represent the data in a different way.

Generic document structure objects - Revision history

Admin at 21:15, 19 May 2010

Admin at 21:14, 19 May 2010

Admin at 21:13, 19 May 2010

Admin: Created page with 'Two parts: *data structures representing the document structure *text formatting It's important to keep the distinction between the two. Representations for the first are indep…'

Admin: Created page with 'Two parts: data structures representing the document structure text formatting It's important to keep the distinction between the two. Representations for the first are indep…'