Markup in the Writing Classroom

<ref>

(reference) defines a reference to another location; can contain any URI

<pb/>

(paragraph break) empty element, indicates a new paragraph of text, use to delineate individual paragraphs where necessary, such as in background or answer material

<note>

(note) contains a note made on the text intended to provide additional information or comment upon the text; requires a @type attribute and a @resp (responsible party) attribute with your id for peer reviewer note

<q>

(quote) quoted text.

<visual>

Visuals are any variety of in line imagery used to break up long lengths of text, and/or aid in the understanding of a topic. Comics, pictures and graphics are a few of the possible visuals that can be used [requires @url].

<annotated_bib>

(annotated bibliography) container element for writing project 1; includes a problem statement and at least one group of citation and annotation elements

<annotation>

(annotation) must follow a citation element; contains required background, summary, and relevance element(s)

<author>

(author) contains author of work (either assignment of source) [use @n for ordering; use @xml:id for assignment authoring]

<background>

(background information) anything that could help provide context or information with regard to the source you are using; can contain text, and optional q elements [requires @type element]

<citation>

(citation) a properly cited document [use @n attribute for ordering; @style attribute for citation style]

<problem_stmt>

(problem statement) contains the problem statement for which the citations and annotations are relevant

<ref>

(reference) defines a reference to another location; can contain any URI

<relevance>

(relevance) where the source can be used and why the text may be pertinent to the problem statement; can contain text [requires @type attribute]

<summary>

(summary) summarization of the source, can be general information, interpretive summary, and/or summary of the research approach; can contain text, notes, and optional q elements [requires @type element]

<blog_post>

Root element for Science Blog genre

<analogy>

Analogies should be used to better illustrate important and difficult to understand topics put forth by the other elements.

<important_idea>

Major points of interest relating to the topic [takes @n attribute].

<list>

A multipurpose list element. [required @type; values can be: "generic" or "roadmap"]

<misconception>

Lists any common misconceptions the public has about the topic, or includes quoted material from the community that highlights the existing (false) notions about the answer; optional [takes @n attribute]

<section_header>

'background' and ‘answer’ are best broken into modular digestible sections consisting of several paragraphs. ‘section_header’ should be titled in a way such that the following paragraphs either work in concert to make the point specified by ‘section_header’, or answer a question put forth by ‘section_header’.

<ref>

Hyperlink around a phrase that directs to a source or resource, can be found throughout the post depending on author's preference

<pb>

(paragraph break) empty element, indicates a new paragraph of text, use to delineate individual paragraphs where necessary, such as in background or answer material

<background>

The sectionintroduces the main topic.

<question>

The question or topic that we are trying to answer or simplify to a general audience.

<technical_principle>

Fundamental theory and concepts involved (such as gravity, matter and energy, fluid dynamics, acid-base reactions, etc.). Global element, required in background, suggested in answer section.

<answer>

Body of text that moves towards the answer of the question, presenting topics, ideas, analogies, and explanations that lead towards the ultimate conclusion

<sources>

Contains sources the author used to answer the question. Can include optional <citation> sub-elements

<specific_topic>

Specific scientific principles that are directly relevant to the explanation of the question. Ex. A description of the chemistry behind acid-base reactions. [takes @n attribute]

<explanation>

An in-depth reply to the question proposed in the “background” section. Typically, the author will use common vernacular and devices such as analogies and visuals in order to clearly convey concepts to readers.

<conclusion>

A conclusion that sums up what was just explained. It acts as a concise response to the question asked in the “background” section

<fsb_rpt>

(Feasibility Report) container element for writing project 2. Contains any number of pages. Cannot contain text by itself. Can only contain text in pages.

<page>

Representing any page of the feasibility report. [required @type attribute] Available types: @ttl, @tbl_contents, @exec_sum, @pre_req_ana, @fsb, @sccs_crt, @dsn, @cost, @rpt, @rsk_ana, @fnc, and @conc.

possible @type values:

• ttl: (Title) contains a mandatory Title, date of submission, and list of contributors. Logo and sub-title optional.
• tbl_contents: (Table of Contents) contains any number of elements.
• exec_sum: (Executive Summary) [Requires @type attribute] a quick summary of the whole presentation. From these paragraphs you should be able to understand whether or not the author supports the project, the most critical limitations / benefits where applicable. Can use as a paragraph break.
• pre_req_ana: (Preliminary requirements analysis) This page type contains the evaluation of the environment for the project before beginning it. Contains any number of elements.
• fsb: (feasibility) This page type Contains any number of elements. Bulk of the total report.
• sccs_crt: (Success criteria). This pages contains the pre-defined requirements for the project to be declared successful. Contains any number of elements. Easy to confuse with the page @pre_req_ana, or the preliminary requirements analysis. This page contains the technical aspects describing the actual project rather than the environment surrounding the project and it’s success.
• dsn: (Design or Diagram). This type of page is a diagram or image that shows a quick highlight of the system / structure. Usually outline interconnecting parts. Must be an element with the url attribute.
• cost: (Cost Estimates) The Cost estimates page contains any number of elements
• rpt: (Report page) Not to be mistake with an estimate, this page is about outlining how you show or prove progress on your project and how you will report that progress. Examples include the medium / genre for your report. Who you are reporting too, and what deliverables you will have. Deliverables could include a tour a facility / physical project, or an interactive demo of software. Includes any number of elements.
• rsk_ana: (Risk Analysis) chart/graphics/paragraph dedicated to covering certain risks and how your project will avoid them
• fnc: (Financial) This page is for a detailed financing plan if necessary. May be covered already by previous sections if not as detailed. Examples for this page include:
• conc: (Conclusion) The conclusion page consists of a body of writing that is three parts. It contains one of each of the following elements. This page should be very direct and to the point.

<sect>

(Section) is an element for each listing in the [requires a mandatory @num attribute and an optional @lvl (level) attribute denoting its level in the hierarchy]. A element with @lvl=1 will be numbered with a roman numeral corresponding to its native @num attribute. A element which has @lvl=2 will be lettered corresponding to its native @num attribute (@num=1 shows A, @num=2 shows B, etc) and indented below its parent. A element @lvl=3 will be denoted with its native @num attribute and indented twice below its parent. Each use of a sub level begins again at @num=1.

<app_ovr>

(Application overview) a highlight of certain element of the project/idea. This can be anything from you/your team's goals to how it interacts with other products, projects, and systems. [requires an @type attribute, optional @title attribute]. Available types: obj (referencing a personal, team, social, or business objective), synergy (referencing the way your project will interact with any type of existing infrastructure), rls (referencing the any rules or regulations the project will encounter whether for better or worse).

<fsb_hlgt>

(feasibility highlight) Body of this element is the general summary of this aspect of feasibility [required @type attribute and @num attribute] available types: @tcnl (technical), @econ (economic), @tfrm (timeframe), @socl (public reception), @suits (legality), or @envr (environmental)).

<req_sect>

(requirement section) details a sections of requirements. Strictly related to the project’s components. For example an appropriate element would be “userinterface”, “Database/database interaction”, or “construction”. A element is simple an italicized and underlined above each of its requirement.

<req>

(requirement). This is a requirement. [required @num attribute, optional @title attribute]. Title will appear at the beginning of this element italicized followed by a colon.

<est>

The element represents an estimated cost [required @type attribute]. Available @types: inst (institutional), @envr (environmental), @lgl (legal), @fnc (financial).

<tmln>

(Timeline) The tmln element is an optional element design to provide a timeline entry [required @date (written in mm/dd/yyyy) and @num] attribute. Date will be highlighted in bold with the text following it. Each will have a line between them of blank space.

<fnc>

(financial highlight). [required @num, and @type attribute] example @types: @fund (Funding), @lns (loans), @exp (expenses), @brdn (Burden to company / organization).

<Fsb>

This element is used to answer your thoughts on the question “Is it feasible” and why.

<cond>

This element is used to identify the key conditions for feasibility. Such as meeting a timeframe or extended financial support. Maybe even address certain doubts on the feasibility.

<sum>

This element summarizes the whole report.

<ref>

(Reference) This element is global, and allows the user to include an outside source. Citation includes [Required @author, @title attribute]. Body consists of URL.

<pub_init_proposal>

<cover_page>

<submit_date>

<audience>

Who this proposal is directed towards/aiming to convince

<tbl_cont>

(table of contents)

<section>

Section: Name of section of proposal

<intro>

Brief synopsis of the project being proposed

Brief synopsis of the project being proposed

<crnt_cond>

Current Conditions: Information about the subject matter that establishes a need in the reader’s mind for the change suggested by the proposal

<subj_hist>

Subject History: relevant material that has lead to the current conditions or the current

<background>

General information providing context for the problem

<scope>

<objective>

Objective: What the purpose of the project is

<goal>

Goal: Improvements that would be achieved upon completion of the objective.

<purpose>

Point of background requiring action and proposed solution

<action>

Action: Executable item that will lead to goal completion

<execution>

Execution: Tactic employed to achieve goal

<approach>

How the project will be achieved

<environmental>

Environmental: Initial and long-term implications or obstacles as they relate to the surrounding environment

<social>

Social: Initial and long-term implications or obstacles as they relate to members of the community

<economic>

Economic: Initial and long-term financial implications of project compared to do-nothing alternative

<feasibility>

Initial and long-term implications or obstacles in the implementation of the project

<conclu>

Conclusion: Brief description of the benefits potentially provided by the proposed project

<references>

References: List of cited works used in research

<cover_letter>

Container element for cover letter

<header>

Container element for applicants basic contact information

<name>

First and last name of applicant; necessary in both the signature and header of document

<contact_info>

Container element for contact info, must be filled with at least one type of contact

<contact>

Element for contact information, must include at least one attribute from an open list (with address, phone number, and email as suggestions)

<greeting>

Contains formal greeting to reader such as “Dear”, as well as an identifier for the intended audience

<intro_para>

(Introductory paragraph) Container element for first paragraph of cover letter; has intent and proposition as necessary sub-elements but may contain other text as well as optional sub-elements, cover letter may only contain one introductory paragraph

<intent>

Statement regarding the purpose of the cover letter

<reason>

Statement of reason for applying for this particular or a job in this field, may include applicant's interests or passions in the field they are seeking a job in, optional sub-element in introductory paragraph

<proposition>

General statement for why applicant is deserving of job, closing statement for introductory paragraph

<para_background>

(Background Paragraph) Container element for paragraph including information about candidate experience, cover letter must include one or more background paragraphs

<experience>

Container element for types of relevant experience talked about in cover letter, must include at least one attribute (school, work, personal)

<languages>

Sub-element of experience, known languages of the applicant

<skills>

Sub-element of experience, applicant skills, preferably ones that match skills listed in the job posting

<accomplishments>

Sub-element of experience, applicant accomplishments relevant to the job description

<certifications>

Sub-element of experience, applicant certification relevant to the job description

<programs>

Sub-element of experience, known program languages of the applicant

<closing_statements>

(Closing Paragraph) Container element for compatibility and next step, mandatory element, cover letter must include (only) one closing paragraph

<compatibility>

Sub-element to closing paragraph; briefly, why applicant fits into the company and what he or she has to offer. Must be first element in closing statement.

<next_step>

Sub-element to closing paragraph; Invitation to further discuss qualifications and details of position, closing statement for closing paragraph. Must come after compatibility statement.

<acknowledgment>

Optional element for saying thank you to the reader for their time/consideration etc.

<signature>

Mandatory element in cover letter, container element for signing off of cover letter; includes salutation and name.

<salutation>

Sub-element to signature; Sincerely, Best, Cheers, etc…