The CORE Econ website uses essential cookies to make our website work. You may disable these using your browser settings but this may affect website functionality (such as your access to logged-in resources). We would also like to use analytics cookies to help us improve the functionality of our website and improve your user experience. These analytics cookies will be set only if you accept. We do not sell or otherwise transfer personal data or usage data to any third parties or use it for any other purpose. For more detailed information about the cookies we use, see our Privacy policy.

CORE Econ Publishing Documentation The CORE feature set

These are all of the features available for CORE publications, their purpose, descriptions, and instructions on how to format or tag each one within manuscripts (for example, Google Docs).

For formatting or tagging features within existing publications that are already stored as markdown within a code repository, refer to existing examples or seek assistance from the EBW project lead.

Header image

Description and purpose Comments and examples Formatting/tagging within manuscripts
Each unit needs a powerful, striking visual opener that captures what that unit is about.
These should follow the same style throughout the book.
They may be used in the landing page’s visual table of contents, as is the case for The Economy 2.0		 For examples, see The Economy 2.0 Macroeconomics’ contents page and Microeconomics Unit 1.

A free-to-use image can be sourced (for example, open licensed or public domain) or an image can be purchased from authors, photographers or stock image libraries. EBW can assist with image research and selecting suitable options in the CORE style. Once a final option is selected, if it is under license, CORE will purchase it so that they hold the license to display it on the CORE site or ebook.		 Name the image file by unit number, and include a tag at the start of the document indicating that name, for example:

[include unit-01-header]

Include a descriptive caption for the header image within [header image caption] and [end header image caption] tags.

Headings

Description and purpose Comments and examples Formatting/tagging within manuscripts
Headings indicate the hierarchy of information within a unit and organize the content into manageable chunks.

Level 1 headings are unit headings.

Level 2 headings are section headings. In 1.0-based books, they form a collapsible ‘accordion’, which provides an overview of the contents (unit outline). In 2.0-based books, each section is included on its own web page, and the level 2 heading is at the start of each page.

Level 3 headings are used for sub-sections and sub-feature headings (for example, within boxes or extensions).		 Use the document menu or markdown to apply the relevant heading level (for example, ‘Heading 1’, or `#`), rather than styling headings by applying a font size, bold, italics or underline.

An example of a unit and section heading is in Microeconomics Unit 1 and that unit’s section 1.2, which includes level 3 headings within the ‘Great economist’ box and extension.		 Use the document formatting menu to apply heading levels as follows:
  • Unit title: heading 1, ‘h1’
  • Section heading: heading 2, ‘h2’
  • Subsections and all in-feature headings (for example, boxes, extensions, exercises, multiple-choice questions): heading 3, ‘h3’
  • Sub-subsection heading: heading 4, ‘h4’

Number h1s (unit titles) with the unit number.

Number h2s (section headings) with the unit number and chronological section number. The exceptions are The Economy 1.0 and Doing Economics where the first section below the introduction in Unit 1 is 1.1. The introduction section is not numbered.

H3s and h4s are not numbered.

Subheadline

Description and purpose Comments and examples Formatting/tagging within manuscripts
The subheadline is a brief sentence or two included at the start of a unit of The Economy 1.0 and 2.0, below the h1 unit title. It expands on the unit title introducing the concepts that the unit covers.

 In The Economy 2.0, the subheadline should be brief enough to be included beneath the unit title in the visual table of contents on the landing page.

See the contents section of The Economy 2.0’s landing page for examples of subheadlines as well as Section 1.1 of Microeconomics.		 The subheadline should be included below the header image caption and between [subheadline] and [end subheadline] tags in the manuscript.

Introductory section

Description and purpose Comments and examples Formatting/tagging within manuscripts
Begin a unit with some explanatory text that introduces the concept covered in the unit.

 While writing an introduction, keep in mind CORE’s aims of addressing the sorts of questions that motivate students to take up economics, helping students to understand economic challenges in the real world, and preparing students to confront such challenges.

This is an example introduction from the ‘Government debt and wealth in the Global South’ Insight.		 In The Economy 2.0, the introduction is the first numbered heading after the unit title. The heading does not include the word ‘Introduction’.

In Doing Economics, the first heading after the project title should be for the ‘Learning objectives’, with the next heading for the ‘Introduction’. Neither of these are numbered.

In other CORE publications, the introduction is the first numbered heading after the unit title and uses the word ‘Introduction’. For example ‘1.1 Introduction’.

Defined key terms

Description and purpose Comments and examples Formatting/tagging within manuscripts
Pop-up definitions provide contextual definitions and explanations of emphasized key terms throughout the content.

The key terms should still be explained in the text; a definition is not a replacement for an explanation of the term within the text.

They can be long, if necessary (up to 100 words).

Where relevant, they can include cross-references to other terms or examples (for example, ‘see also’, ‘also known as’, ‘for example’).
 All key terms must be defined.

Definitions pop up in the web format, and sit in the sidebar for print.

The terms and definitions are also included in the glossary at the end of the book.

Terms are glossed the first time they appear in the body text (this excludes headings, captions and MCQ feedback) of the unit.

Terms can be glossed a second time, if the authors believe it’s necessary to provide the definition in context (for example, when the term needs to be understood to answer an MCQ or exercise).

Avoid repeating the glossary term in its definition.

The glossary term, where possible, should be defined in its singular form.

Examples can be found throughout The Economy 2.0, for instance ‘gross domestic product (GDP)’ in Microeconomics section 1.2 (also see the full glossary).		 Make the term bold (to keep things clear for the digitiser, avoid using bold for any other purpose besides indicating a defined term; deviations from this are at the copy-editor's discretion).

Then add the term and its definition to the glossary sheet (template here).

There can only be one definition per term, so check if the term already exists in the sheet before adding it again.

See the editorial conventions for glossary entries.

Figures

Description and purpose Comments and examples Formatting/tagging within manuscripts
Visual examples of concepts being discussed should be given as often as possible. They break up the text and provide opportunities for visual learning.

Figures may be:
  • Graphs
  • Charts
  • Illustrations
  • Other artwork, such as images or photographs
  • Tables (to summarize and present data)
    		•  If there are graphs created from real-world data, they need to be provided in Excel or Google Sheets format (data and draft graph). For illustrative charts or graphs not based on data, supply a reference figure for recreation in the CORE style.

    For accessibility purposes, when making a graph from real-world data, consider whether non-sighted users would benefit from having a table showing this data, presented underneath the graph.

    Figures must be numbered sequentially through each unit by unit and figure number, for example, Figure 1.1 for the first figure in Unit 1.

    Examples of figures can be found throughout The Economy 2.0. See the list of figures in Microeconomics.    		 Each figure needs to be numbered sequentially, and have a caption. It may also include a source (reference). For graphs created from real-world data, the source for that data needs to be included.

    Best practice for accessibility is also to include alt text, which describes images to users who cannot see them. This description is read out by assistive technology, such as screen-readers or virtual assistant devices. It also improves the site’s SEO. You can include the image description next to an ‘alt text’ tag in the figure information.

    Include all of the figure information within a square-bracket tag below the image, like this:

    [Figure 1.1]
    [caption] Put the caption here, with a full stop at the end.
    [alt text] Include a comprehensive image description here.
    [source] If one is necessary, put the source here.

    If the figure is a table, insert it below the figure information using the document menu.

    Multi-image figures (slidelines)

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    It is often useful to explain a step-by-step process or complex concept visually, one aspect at a time. In these cases, use multi-image figures.

    		 In order for graphs to be accurate, they need to be created from data, therefore graphs must be provided in Excel or Google Sheets format.

    Before including a table, consider whether the data could be presented more clearly as a graph.

    This is an example from The Economy 2.0: Microeconomics.    		 Each figure needs to be numbered sequentially, and have a caption. Multi-image figures are numbered as image a, b, c … within one figure, but each image can have its own caption or source.

    If the figure is a table, insert it below the figure information using the document menu.

    Best practice for accessibility is also to include alt text, which describes images to users who cannot see them. This description is read out by assistive technology, such as screen-readers or virtual assistant devices. It also improves the site’s SEO. You can include the image description next to an ‘alt text’ tag in the figure information.

    Include all of the figure information within a square-bracket tag below the image, like this:

    [Figure 1.1 summary]
    [caption] Put the caption which applies to the entire figure here, ending with a full stop.
    [alt text] Include an image description here.
    [source] If one is necessary, put the source which applies to the entire figure here, ending with a full stop.

    [Figure 1.1a]
    [title] Each slide has a title. Put the title for slide a here, no full stop
    [slide-caption] Each slide has a caption. Put the caption for slide a here, ending with a full stop.
    [alt text] Include an image description here.
    [source] If one is necessary, put the source here.

    [Figure 1.1b]
    [title] Each slide has a title. Put the title for slide b here, no full stop
    [slide-caption]: Each slide has a caption. Put the caption for slide b here, ending with a full stop.
    [alt text] Include an image description here.
    [source] If one is necessary, put the source here.

    [Figure 1.1c]
    [title] Each slide has a title. Put the title for slide c here, no full stop
    [slide-caption]: Each slide has a caption. Put the caption for slide c here, ending with a full stop.
    [alt text] Include an image description here.
    [source] If one is necessary, put the source here.

    And so on …

    Excel and Google Sheets walk-throughs

    Economy, Society, and Public Policy and Doing Economics feature step-by-step instructions on how to create charts in Excel and Google Sheets. These instructions are included as screenshots with labels added, and are organized as slidelines.

    As with all other slidelines, the screenshots get a figure number.

    Each screenshot in the slideline has a title and a caption.

    Only text that has a corresponding action, or points to data on the screenshot, gets a label. All other text forms part of the image caption.

    See the artwork stylesheet for label styles.

    Exercises

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    Exercises get students to analyse and respond to information or data presented in the unit. Exercises should be numbered sequentially throughout each unit by unit and exercise number, for example, Exercise 1.1 for the first exercise in Unit 1.
    See any of the examples in The Economy 2.0: Microeconomics.    		 [exercise]
    Exercise 1.1: Descriptive subtitle

    Place the content between these tags. There is no need to use any additional formatting, such as placing it within a box.
    [end exercise]

    Multiple choice questions (MCQs)

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    Self-marking multiple-choice questions (MCQs) allow students to assess themselves and get immediate feedback, which consolidates their learning. There can be only one question, with at least one correct answer. There can be more than one correct answer.

    Each question can include two or more answer options for the student to choose from. CORE convention is to have exactly four answer options per question.

    Feedback for both correct and incorrect answers needs to be supplied. Questions already include the automated feedback of ‘correct’, ‘incorrect’ or ‘you have not selected all of the correct options’, so feedback such as ‘correct’, ‘incorrect’, ‘true’ and ‘false’ should be avoided as it results in duplicate feedback.

    Rather use the feedback as an opportunity to explain the information.

    This is an example from The Economy 2.0: Microeconomics.    		 MCQs should be numbered sequentially throughout each unit by unit and MCQ number, for example, Question 1.1 for the first question in Unit 1.

    Place the MCQ’s question, options, and feedback after a numbered question heading (h3), like this:

    Question 1.1
    The question itself and any explanatory text, figures or links go here.

    Then list the options, placing hyphens next to incorrect options and pluses next to the correct options.

    + So this would be a correct option in the list.
    - And this would be an incorrect option.
    - And another incorrect option.
    + And a correct option.

    Then follow that with a normal bulleted list containing feedback for each option in the same order:
    • So this bullet gives feedback for the first option in the above list.
    • And this one for the second option.
    • And this one for the third option.
    • And this one for the last option.

    Boxes

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    Various boxes are used across CORE publications to visually distinguish different types of content. The following box types exist (examples linked):

    ‘Great economists’, ‘When economists disagree’, and ‘How economists learn from facts’ boxes all share a visual style.

    Info boxes

    Expandable Find out more boxes, Walk-throughs and Extensions share functionality and a visual style.

    Concepts introduced

    Before you start, used in The Economy 2.0

    Avoid repurposing boxes without involvement from CORE and EBW, as readers may have come to associate a certain style of box with the type of content it usually contains.    		 Indicate the box type within the [box] tags:

    [box]
    Heading formatted as an h3

    Place the content between these tags. There is no need to use any additional formatting, such as placing it within an actual text box.
    [end box]
    Description and purpose Comments and examples Formatting/tagging within manuscripts
    You may wish to cross-reference external or internal content by including a link.

    External hyperlinks will go to another website or resource outside of the book when the reader clicks on them.

    Internal hyperlinks will go to a piece of content within the book (other units, book features or sections) when the reader clicks on them.

    See the editorial house style for guidance on when to add links.    		 The tinyco.re format should be used for all external links. Don’t use a website’s full URL or another URL-shortening service, the main reasons for this being consistency within the book and between projects, and because once a print or PDF version is released, it’s much easier for users to follow the link in CORE’s shortened format.

    Internal hyperlinks are usually included only where the cross-referenced material is not within a few paragraphs of the link, otherwise they can become distracting. For example, not every mention of Figure 1.1 needs to link to that figure, only those which occur in other sections or book features (an MCQ or exercise, for example).    		 Add links to external resources from the document menu or indicate them with square and round brackets. Always use CORE’s tinycore link format. For example: ‘Adam Smith’s [Wealth of Nations](https://tinyco.re/9804148) is a ground-breaking text.’

    Create the requisite tinyco.re links on bit.ly by following the guidelines on creating tinyco.re links.

    Where a cross-reference to an internal resource is clear, EBW will add hyperlinks where necessary during digitization (for example, ‘see Figure 1.1’). When in doubt, underline the portion of text you’d like to be an internal link. Where it is not obvious what the text should link to, indicate that through the use of instructions in square brackets (for example, ‘read [the case study for more information](link to section 1.2)).

    Sidenotes

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    Sidenotes link to supplementary information or provide brief commentary on the related paragraph.

    Information that doesn’t fit into the main narrative, but is interesting, can be included as a sidenote. However, keep in mind that sidenotes perform a similar function as footnotes, and should be used sparingly and for small portions of content only (about 100 words). If the information is as long as a paragraph, it should rather be incorporated into the body text.    		 Examples of regular sidenotes can be found throughout CORE ebooks. The Economy 2.0 also makes use of Building block sidenotes. If a building block sidenote links to multiple sections, provide the title that must be used in the building block.

    Make sure that key points are included in the main text and the ‘sidenotes’ are additional (non-essential) pieces of information.

    Position sidenotes above the paragraph next to which they should appear on the web. On smaller screens, they will appear after the paragraph they sit alongside on wider screens.    		 [sidenote]
    Place the content between these tags. There is no need to use any additional formatting, such as placing it within a box.
    [end sidenote]

    Videos

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    Audiovisual material enhances the content.
    Only YouTube and Vimeo videos can be embedded.    		 Examples from The Economy 2.0: Microeconomics Each video includes a description (like a caption). Include the video link and description within a square-bracket tag below the image, like this:

    [Video] Put the link to the video here
    [description] Add the video description here, ending with a full stop. This description appears below the video.
    [title] Add a video title here. This title does not appear on screen and rather is used by screen-readers to describe what the video is. This doesn’t need to be long like the alt text for figures, but rather, a short title distinct from the video description.

    Footnote references (citations)

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    Citations within the body text are included within footnotes so that they are unobtrusive and do not interrupt the flow of reading.

    Footnotes are displayed as numbered pop-ups in the web format.    		 Refer to the house style for guidance on referencing styles and the distinctions drawn between bibliographic and citations/footnote references.
    During digitization, footnote references are automatically gathered into and end-of-section list. On the web, this repeats the footnote pop-ups within the section, and in print (where there are no pop-ups) it provides a list of the numbered references.
    Examples can be found throughout The Economy 2.0, like this one in Unit 1 of Microeconomics.    		 Insert footnote references from the document menu:

    ‘Insert’ > ‘Footnote’

    Bibliographic references

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    A ‘References’ section at the end of each chapter or unit summarizes the bibliographic references it includes. These are collated into a end-of-book bibliography. Read the house style for guidance on referencing styles and the distinctions drawn between bibliographic and footnote references.

    Example from Unit 1 of The Economy 2.0: Microeconomics    		 List the bibliographic references within a final ‘References’ (h2) section of the unit. EBW will automatically add them to the end-of-book bibliography.

    Extensions

    Description and purpose Comments and examples Formatting/tagging within manuscripts
    These sections are optional and expandable. They are not intended to be included in printed books, although they include an introductory preview paragraph which is visible in print.

    Extensions were referred to as ‘Leibnizes’ and ‘Einsteins’ in The Economy 1.0.    		 Some extensions require more mathematical knowledge than others. This can be indicated in a sentence at the start of the extension. For example: ‘This extension makes use of calculus; to understand it you will need to know how to differentiate simple functions and interpret derivatives.’ Where the use of maths is less central, it could just say ‘it will be helpful if you know how to …’.

    Example from Unit 1 of The Economy 2.0: Microeconomics    		 [extension] Place the content between these tags. There is no need to use any additional formatting, such as placing it within a box.[end extension]

    The first paragraph of the extension, which will be visible when the expandable extension box is closed as well as in print, should be placed between [preview] and [end preview] tags.

    Questions and/or exercises in extensions are numbered separately by unit, with an ‘E’ for extension, for example: Exercise E2.1. For units with more than one extension, the exercise or question numbering continues throughout (for example, the first extension has questions E2.1 and E2.2, the second extension has questions E2.3, E2.4, E2.5, and so forth).