Markup Program¶

Markup program is a desktop Application (macro in Microsoft Office Word), to identify bibliographic elements in documents, according to SciELO DTD for article and for text, based on standard ISO 8879-1986 (SGML - Standard Generalized Markup Language) and ISO 12083-1994 (Electronic Manuscript Preparation and Markup). Nowadays there is a new SciELO DTD: doc. It is simpler than article and text because there are less levels, but by the other hand, there are more elements to identify. It must be used to identify the elements to generate XML according to SPS.

Functionalities¶

identify the elements of articles and texts in a Word Document
identify semiautomatically the elements of the references.
validate the markup according to article, text, and doc.
generate XML files according to SPS and JATS DTD.
validate XML files according to SPS and JATS DTD.

How to open¶

Use the Windows menu to open the program.

Or use Windows Explorer and click on markup.exe:

c:\scielo\bin\markup\markup.exe

Word Program location¶

Markup Program will try to open the Microsoft Office Word Program. If it is unable to open it, inform the correct path of Microsoft Office Word Program.

Or edit, c:\scielo\bin\markup\start.mds, inserting the Microsoft Office Word path. E.g.:

“c:\arquivos de programas\microsoft office\office11\winword.exe”

Enabling macro execution¶

Markup Program requires permission to run macros

_images/markup_2007_habilitar_macros.jpg

Markup button¶

If Word program opens properly, Markup bar will appear at the bottom of the screen.

From Word 2007, it is different. The Markup bar will appear inside the Supplement group.

_images/markup_2007_botao_suplementos.jpg

Loading macro manually¶

If there is no Markup button. You can try to load the macro manually.

Select the Tools->Supplements and Models option of the menu.

Remove the incorrect item and inform the right path corresponding to c:\scielo\bin\markup\markup.prg.

Overview¶

Open only one file of article or a text file (.doc or .html).
Click on Markup button.
Click on Markup DTD-SciELO.

white: operations over the document: edit or eraser a tag and automatic markup
orange: floating tags, which can be used in any part of the document
green: tags which requires an hierarchical structure

From Word 2007, all these tags bars are grouped in Supplements.

_images/markup_2007_posicao_das_barras.jpg

Operations bar¶

Exit button¶

To exit the program, click on Exit button.

Choose one of the options bellow.

Edition tag’s attribute button¶

To edit attributes of an element, click on the element name, then click on the edit button (pencil). Edit the values of the attributes, then confirm this action.

Delete tag button¶

To delete one element and its attributes, click on the element name, then click on the delete button. The program will ask to confirm this action.

Save file button¶

To save the file, click on the save button.

Automata 1 button¶

To identify automatically the elements of the bibliographic references:

It requires that the journal has an automata file (read how to program an automata), which configures the rules to identify the references elements.

Click on a paragraph of one bibliographic reference
Click on the Automata 1 button.

This action will activate a tool which will try to identify automatically the bibliographic reference elements. The tool will present the several possibilities of identification. Choose the correct one.

Automata 2 Button¶

To identify automatically a set of bibliographic references (available only for Vancouver standard).

Select one or more bibliographic references

Click on the Automata 2 button.

The program will try to identify all the references, keeping the original reference identified as [text-ref]. Thus the user can compare the original to the detailed identification in order to check if the reference was properly identified, and correct it, if necessary.

Automata 3 button¶

To identify automatically the elements of the bibliographic references:

It requires that the journal has to adopt a standard (APA, Vancouver, ABNT, ISO)

Click on a paragraph of one bibliographic reference
Click on the Automata 3 button.

This action will activate a tool which will try to identify automatically the bibliographic reference elements. The tool will present the several possibilities of identification. Choose the correct one.

Save button¶

Click on this button to save the document.

SGML Parser button¶

_images/markup_operations_bar_parser.jpg

Click on this button to validate the SGML Markup. It will convert the file to .txt and will open it in the SGML Parser program.

Generate XML button¶

After identifying all the elements of the document, click on this button to generate the XML file.

Files and DTD errors report button¶

_images/markup_operations_bar_err_report.jpg

Click on this button to view the report of files and DTD errors.

SciELO Style Checker report button¶

_images/markup_operations_bar_xml_style_report.jpg

Click on this button to view the report of SciELO Style Checker.

Contents Validations report button¶

_images/markup_operations_bar_data_val_report.jpg

Click on this button to view the report of Contents Validations.

PMC Style Checker report button¶

_images/markup_operations_bar_pmc_style_report.jpg

Click on this button to view the report of PMC Style Checker.

View Markup button¶

The operations bar would be presented with some buttons unavailable when any report is displayed.

_images/markup_operations_bar_reports.png

Click on this button to view the SGML file.

_images/markup_operations_bar_view_markup.jpg

Floating tags bar¶

The floating tags are for the elements which appear in any part of the document.

Hierarchical tags bar¶

This bar groups the elements which follow an hierarchical structure.

The highest level are doc, article, text.

Tag¶

Select the text you want to identify.
Click on the tag button which identifies the text. For example: to identify the first name of an author, select the text corresponding to the first name, then click on fname.
Some elements have attributes. Complete the form with the values of their attributes.
Some elements have children (agroup other elements). As it is identified, the bar of the lower level is displayed.

Read the SciELO Markup Elements and Attributes