<LML /> 2.0 - Block Markup Module

specification

Author: Dr. O. Hoffmann (German web-page)

This module belongs to the Literature Markup Language Version 2.0

Changes

There are many new elements in LML 2.0 indicated in the element index with (v2).

Element-Index

Complete Element and Attribute Index

Content Block Elements

literature

Description

Type: Block

This element corresponds to the root element of an LML document. Every content is literature, therefore is everything included in the literature element. There is often no need to use this element within a role attribute, because the host language has its own root element. But in a format not related to literature it might be useful to indicate clearly a change from something else to literature.

A second functionality is to separate embedded content from other authors. For this within the document there is another literature element noted, containing the independent content respectively document fragment.

version

Description

Type: Attribute

The element literature has a specific attribute version, indicating the LML version of the current document (fragment). The value is a string, containing a version information.
For the version 1.0 one may write: version = "1.0".
For version 2.0 one may write: version = "2.0".
Within another host language using literature as a role value, one may use the attribute on the same element with an LML prefix as usual for attributes from foreign namespaces. Without a version indication, the current/latest version is assumed (whatever this means, depends on the user-agent; human readers might be able to guess this better from the date, a document was published too).

If LML fragments are used in compound documents, it might be useful too, to indicate which version is meant. Authors are recommended to use a literature element with a version attribute in such a case for larger fragments; if no literature element is used as container, authors may reference the version with a CURIE in a role or property attribute.

Relations

Literature samples

A small anthology of flash fictions.
Obviously most other samples are samples for literature too, this mainly shows nested literature elements.

abstract

Description

Type: Block

An abstract is a summary, typically at the top of an article or report. This is especially usual at the top of scientific articles.

Relations

ackno

Description

Type: Block

Acknowledgements related to the documents, an expression of thanks to somebody for ideas, discussion, typically at the end of the document or article.

Relations

act

Description

Type: Block

An act of a stage play or drama etc.

Relations

acting

Description

Type: Block

A container for a list of characters typically at the beginning of an act or scene of an stage play or drama etc.

Relations

affiliation (v2)

Description

Type: Block

A person's present or past affiliation with some organisation, for example an employer or sponsor.

Relations

afterword (v2)

Description

Type: Block

Afterword, explains for example different editions or changes in the work, in general comments about the work.

annotation (v2)

Description

Type: Block

Marginalia, notices, comments about a work or parts of it, typically referencing the discussed fragments explicitly, here collected in a separate container at the beginning or end, not within the content of a work (in digital works instead of footnotes, in LML as well within meta).

appendix

Description

Type: Block

Container for an appendix. Typically if present this is appended to the end of a book, article, report or general a larger piece of literature. The issues of an appendix are somehow related to the main part of the rest, but not directly in the focus of the theme. Often it helps to understand the main part.

Relations

aside (v2)

Description

Type: Block

Secondary or supplementary content. A section that consists of content that is tangentially related to other fragments around it. Often this is presented as a sidebar or a box with specific decoration to separate it form the core content.

Relations

blurb (v2)

Description

Type: Block

Blurb, teaser, jacket text for a work.

bq

Description

Type: Block

A container for a quoted text. The cite element provides the information about the source, respectively the author. Typically content from other authors is quoted, and only if mentioned in relation to the current theme and within the current document. This is not necessary, if the other related element is already indicated as independent article (or report) in a collection from different authors, if for each of them is unambiguously specified, which are the authors of each article within the article.

Relations

Samples for bq

chapter

Description

Type: Block

A chapter is a larger part of a book or another larger document.

Relations

co

Description

Type: Block

Often in a magazine, newspaper or an online portal not really related text fragments are jammed together in one document, therefore there is not really only one theme per document. co (component) indicates such a fragment. In contrast to this for example a group of chapters and sections share close relations and the same issue; independent content from different authors are typically indicated either as quotings or with additional literature elements. For components such a separation by author is not required or does not exist. Typical components of magazines or newspapers of online portals are for example a weather forecast, a column or gloss, a news section or advertisement, jokes, cartoons, dictum of the day. While the content of such components changes regularly, the type of the content remains the same for a longer time.

Relations

colophon (v2)

Description

Type: Block

Colophon, metadata about work and author, production notes at the end of a book.

Relations

comment

Description

Type: Block

A comment about another text fragment, typically from another person than the author. This appears often at the bottom of online articles or in blogs, guest books, forums. Of course the author of the comment should be identified too. This is different from a quotation, because normally the author does not quote a comment, the commentator adds the comment himself. Because it is closely related to the issue of the document, this is better than using the element literature to indicate something completely separated or the element co indicating some completely different content.

concept (v2)

Description

Type: Block

A fragment indicating a concept, the required background knowledge for the following content.

Relations

conclusion

Description

Type: Block

A fragment containing a conclusion or summary typically at the end of a scientific article.

dedication

Description

Type: Block

A dedication or inscription, typically somewhere at the beginning of the document.

Relations

discussion (v2)

Description

Type: Block

A container for comments from different persons. This appears often at the bottom of online articles or in blogs, guest books, forums. This is different from a quotation, because normally the author does not quote a comment, the commentator adds the comment himself.

epigraph

Description

Type: Block

A specific type of quotation or inscription at the beginning of a document or document section.

Relations

epilog

Description

Type: Block

An epilog(ue) of a book or larger article, closing statement about what happened after the time range detailed in a book or story.

Relations

errata (v2)

Description

Type: Block

Errata, corrigenda, list of known corrections for a work.

explicit (v2)

Description

Type: Block

The 'end of a work', final statement, colophon.

extroduction (v2)

Description

Type: Block

Extro, opposite of introduction, final statement.

foreword (v2)

Description

Type: Block

Foreword, explains for example different editions or changes in a work, in general comments about a work.

frontispiece (v2)

Description

Type: Block

Container for a frontispiece or facsimile - some initial graphical representation, decorative illustration.

g

Description

Type: Block

A generic block container to indicate a group of elements or text fragments. This is typically used as a container, if there is no other element with a semantic meaning fitting to the intention of the author. Typically a host language will have such a container anyway, there is not need to use this as a role value, but this maybe is useful, if LML is used as the host language itself.

If an author uses this element, because no other element fits to the intended semantic meaning of the text, this may indicate, that there is a semantic gap in the current version of LML. Before this generic element is used, authors may check again, that there is no other element fitting to the intended meaning. Alternatively it is possible, that the intended meaning should be checked again, if this is meaningful.

But there are some applications for a generic container, for example related to the limited capabilities of the used styling language. This cannot be changed with LML, but the usage of a generic container avoids at least the corruption of the semantic meaning with a wrong usage of a meaningful container for the wrong purpose.

Relations

glossary

Description

Type: Block

Container for a glossary. A glossary is a separated part of a project containing a list of words, idioms, expressions, phrases often used in the project and required to understand the content of a project. This helps the reader especially, if the idioms are more precisely defined as in the general use or not used at all in another context.

Relations

glossterm (v2)

Description

Type: Block

Container for a term to be defined in a glossary.

glossdef (v2)

Description

Type: Block

Container for a term definition in a glossary.

The typical substructure of a glossary is a heading followed by a list of terms with definitions, maybe followed by another heading and more terms and definitions and so on. Typically the glossterm appears directly before a glossdef, the glossdef defines the glossterm directly before. It is possible to provide more than one glossterm before a glossterm, in this case the glossterm defines them all. If there is one or more glossdef behind glossterm(s), the definitions apply all to the glossterm(s) before and are intended as alternative explanations.
If a glossdef has no glossterm(s) before, this implicates an empty term, this means, it defines nothing, what is typically not meaningful. If there is no glossdef after glossterm(s), this implicates an empty definition, the term remain undefined.
Other elements before or after do not implicate a term or definition, they simply separate the glossary structure, this means additionally glossdef and glossterm do not apply to glossary content before or after such a separation structure, only to the local group of glossary content.

h

Description

Type: Block

A heading or title of a chapter or section or otherwise separated part of content. Because the heading belongs to this section or part and is therefore expected to be inside the section or part and not before.

Relations

hs

Description

Type: Block

A subheading or subtitle of a chapter or section or otherwise separated part of content. This is intended to follow after the related (main) heading related to the same fragment and does not indicate another subsection or part of the content as for example the h1 - h6 cascade indicates for (X)HTML. In some use cases something like a subheading may precede a heading too, this is not excluded for the usage of this element.

Relations

help

Description

Type: Block

Container for a helping text. Internet projects and interactive applications may need some additional helping suggestions for users, this can be gathered in a help container. With such a structure it is easier to find such a help. Additional information in the meta element of the help may indicate to what the help is related, if this is not obvious.

Relations

This is for example available in (X)HTML as a value for the attributes rel and rev, not as a specific element or attribute. Of course, if rel and rev can reference a help, this should be identifiable too.

Description

Type: Block

There are some stereotype constructions within multiple document projects, especially on web pages at the top of the document or some larger document fragment to contain a heading (including sometimes an image or logo) for a larger project like a book or magazine to indicate such a conception of a larger construction and to identify the project as somehow unique. Sometimes this is called 'corporate design'. This is the element to contain such information. One advantage is, that for non visual presentation the user can simply skip this document fragment, if identified to be already known.

Relations

Description

Type: Block

There are some stereotype constructions within multiple document projects, especially on web pages at the bottom of the document or some larger document fragment to contain some stereotypes like contact data, copyright notes, repeated content for a larger project like a book or magazine to indicate such a conception of a larger construction and to identify the project as somehow unique. Sometimes this is called 'corporate design'. This is the element to contain such information. One advantage is, that for non visual presentation the user can simply skip this document fragment, if identified to be already known.

Relations

incipit (v2)

Description

Type: Block

The 'beginning of a work', initial statement, summary.

Relations

inscription (v2)

Description

Type: Block

Inscription, a specific type of quotation, phrase, poem as supplemental meta content about a work.

introduction (v2)

Description

Type: Block

Introduction, purpose and goals of a work.

Description

Type: Block

A logo is a construction to identify a project, company or person typically represented with some graphic-text combination, maybe contained in a figure. If the logo is only available for a specific representation, for example a graphical or acoustical (jingle) sign, it is expected, that logo contains at least a generic text alternative for example as a descriptive meta information.

Relations

metadata (v2)

Description

Type: Block

Metadata, colophon about the work, directly exposed opposite to meta.

opener (v2)

Description

Type: Block

A general container to collect all frontmatter of a document like foreword, dedications, inscriptions, list of contents etc.

Relations

closer

Description

Type: Block

A general container to collect all backmatter of a document like afterword, appendix, glossary, bibliography etc.

Relations

postscriptum (v2)

Description

Type: Block

Postscriptum, some additional statement, often used in letters.

Relations

preamble (v2)

Description

Type: Block

Preamble, introductory and expressionary statement in a document about purpose and underlying philosophy of a work.

preface

Description

Type: Block

A preface explains motivation, reason to write the work, origins of the idea.

Relations

prolog (v2)

Description

Type: Block

Prolog(ue), background of a story, content of a work, not part of a work itself. This is usually provided to introduce into a story, 'what happened before'.

Relations

s

Description

Type: Block

A section is a larger part of a book or another larger document. Or it is a section of a chapter. If both is used, a chapter may contain sections, but a section may not contain chapters. s may contain s themselves, such subsections have no specific elements, the section level has to be determined according to their nesting.

Relations

depth (v2)

Description

Type: Attribute

depth be used to indicate manually the depth of nesting of an element s. This can for example simplify styling or just for orientation of the author, but has not much semantic relevance. The values is an integer, usually positive.

salute (v2)

Description

Type: Block

A container for some introductory greeting.

Relations

scene

Description

Type: Block

A scene of a stage play or drama etc.

Relations

signature (v2)

Description

Type: Block

A container for a signature at the end of a related block element, containing a signature as texts or as graphics. This appears often at the end of dedications or letters. The purpose is typically, the author of some content wants to pronounce, that him/herself has written this passage as personal statement.

Relations

trailer (v2)

Description

Type: Block

A container for information or description, heading like at the end of a section for example.

Relations

warning (v2)

Description

Type: Block

Container for a warning exposed to the audience.

Block samples

Samples for several block and inline elements.