๐Ÿ“– Documentation v1.0

Ascarya JaTs Editor
User Guide

A complete guide to using the Citation Hyperlinker and JATS XML Editor. From uploading files to exporting publish-ready XML.

๐Ÿ”Ž Overview

Ascarya JaTs Editor is an all-in-one platform for academic manuscript processing. It consists of two main tools:

  • Citation Hyperlinker โ€” Automatically detects citations in your DOCX document, matches them to references, and inserts DOI hyperlinks via CrossRef.
  • JATS XML Editor โ€” Converts DOCX into JATS XML 1.3 ready for OJS, PubMed, and other academic databases, complete with a visual editor.
Ascarya JaTs Editor Landing Page

๐Ÿ’ป System Requirements

RequirementDetail
BrowserChrome, Firefox, Safari, Edge (latest version)
File Format.docx (Microsoft Word / Google Docs export)
InternetRequired for CrossRef DOI lookup & Google Scholar
AccountFree registration required, includes 2 free trials per tool

๐Ÿ‘ค Creating an Account

  1. Visit the homepage and click "Start Trial Account"
  2. Fill in your name, email, and password on the registration form
  3. Check your email and click the verification link
  4. Once verified, you receive 2 free trials for Hyperlinker and 2 free trials for JATS Editor
๐Ÿ’ก Quota Info Your remaining quota is visible in the top bar when logged in: ๐Ÿ”— for Hyperlinker, ๐Ÿงฌ for JATS Editor.

๐Ÿ“ค Uploading Files

After logging in, open the App page to start processing your manuscript.

Upload Area

How to Upload

  • Drag & Drop โ€” Drag your .docx file into the upload area
  • Click to Browse โ€” Click the upload area to select a file from your computer
  • Multiple Files โ€” You can upload multiple files at once for batch processing
โš ๏ธ Important Only .docx files are supported. .doc, .pdf, or .odt files cannot be processed.

โš™๏ธ Configuration

Click the "โš™๏ธ Configuration" panel to customize the processing settings.

Configuration Panel
SettingDescriptionDefault
Citation StyleChoose a citation style or leave on auto-detectAuto-detect
Link ScopeWhich part of the text gets hyperlinkedAuthor + Year
Include PagesInclude page numbers (pp., ch.) in the linkOn
DOIs in ReferencesHow to display DOIs in the reference listReplace with [CrossRef]
CrossRef DOI LookupAutomatically search for a DOI for each referenceOn
Citation ColorHyperlink color for in-text citations#0563C1
Cross-ref ColorHyperlink color for cross-references (tables, figures)#0563C1

โ–ถ๏ธ Processing

After uploading the file and adjusting the configuration, click the "โ–ถ Run Hyperlinker" button.

What Happens

  1. Upload โ€” The file is sent to the server
  2. Parsing โ€” The DOCX structure and references are read
  3. Style Detection โ€” The citation style is automatically detected
  4. Citation Matching โ€” In-text citations are matched to references
  5. DOI Resolution โ€” The CrossRef API searches for a DOI for each reference
  6. Scholar Linking โ€” Google Scholar fallback for references without a DOI
  7. Hyperlink Insertion โ€” Hyperlinks are inserted into the document
  8. Finalize โ€” The final document is saved
โฑ Processing Time On average 30โ€“90 seconds per file, depending on the number of references and CrossRef API availability.

๐Ÿ“Š Results & Download

Once processing is complete, you will see a results summary:

Displayed Information

  • Total Links โ€” Number of hyperlinks successfully inserted
  • Style Used โ€” The citation style detected/used
  • Refs โ€” Number of references found
  • Citations โ€” Number of citations successfully matched
  • CrossRef โ€” Number of DOIs successfully resolved
  • Scholar โ€” Number of Google Scholar links added
  • Unmatched Refs โ€” References that could not be matched

Action Buttons

ButtonFunction
๐Ÿ“ฅ ArticleDownload the hyperlinked DOCX file
๐Ÿ“Š ReportDownload a detailed report (matched/unmatched citations)
๐Ÿงฌ JaTs EditorOpen the file directly in the JATS XML Editor

๐Ÿ“ Supported Citation Styles

Ascarya supports 30+ international citation styles, grouped by format:

FormatExample Styles
Author-DateAPA 6th/7th, Chicago AD, Harvard, Turabian, Emerald
NumericIEEE, AMA, ACS, Nature, Vancouver (NLM)
Note/FootnoteChicago NB, OSCOLA, Turabian NB, MHRA, Bluebook
AuthorMLA 9th edition
๐Ÿ” Auto-detect If you select "Auto-detect", the system will analyze the citation patterns in your document and automatically choose the most appropriate style.

๐Ÿงฌ Opening the JATS Editor

The JATS Editor can be opened in two ways:

  1. From Hyperlinker results โ€” Click the "๐Ÿงฌ JaTs Editor" button on the processing results
  2. Directly โ€” Click the "๐Ÿงฌ JATS Editor" button on the App page, then import a DOCX file
JATS Editor Launcher

After import, the document will be converted into a JATS XML structure and displayed in the visual editor.

JATS Editor Interface

๐Ÿ“„ Front / Body / Back

A JATS XML document is divided into three main sections according to the JATS 1.3 standard:

SectionContents
โ€น Front โ€บArticle metadata: title, authors, affiliations, abstract, keywords, DOI
โ€น Body โ€บMain content: introduction, methods, results, discussion, tables, figures
โ€น Back โ€บReference list, acknowledgments, biography, conflict of interest

Use the tabs in the toolbar to switch between sections, or select "All" to view everything at once.

๐Ÿ”ง Formatting Toolbar

Context Menus

  • โœจ Import โ€” Import a new DOCX file into the editor
  • Heading โ–พ โ€” Change the heading level (H1โ€“H6) or paragraph
  • Insert Content โ–พ โ€” Insert a section, figure, table, formula, or video
  • ๐Ÿ”— Citation โ€” Link selected text to a reference
  • ๐Ÿ“Ž Cross-ref โ€” Create a cross-reference to a figure/table/formula

Text Formatting

  • B Bold ยท I Italic ยท U Underline ยท S Strikethrough
  • Xยฒ Superscript ยท Xโ‚‚ Subscript
  • ๐Ÿ”— Insert link ยท โ€ขโ‰ก Bullet list ยท 1. Numbered list

๐Ÿ“‹ Metadata Panel

The metadata panel on the right side of the editor contains all the information required for valid JATS XML.

Metadata Panel

Metadata Sections

  • General โ€” Article type, DOI, ISSN, volume, issue, pages, language, UID
  • Publisher โ€” Publisher name, location, journal name
  • Date โ€” Date received, revised, accepted, published
  • Permission โ€” License (Creative Commons), copyright holder, copyright year
  • Funding โ€” Funding statement, open access funding
๐ŸŽฏ Validation Badges Yellow badge (โš ) = warning (recommended to fill in). Red badge (โŠ˜) = error (required for valid XML).

๐Ÿ‘ฅ Contributors

The Contributors panel manages authors, reviewers, and editors of the article:

  • Authors โ€” Add authors with name, email, affiliation, ORCID
  • Reviewers โ€” Add reviewers (optional)
  • Editors โ€” Add editors (optional)
  • Correspondence โ€” Select the corresponding author

๐Ÿ“š References

The References panel displays all references detected from the document. Features:

  • Search โ€” Search references by text
  • DOI Badge โ€” References with a DOI are marked with a blue badge
  • Edit โ€” Click a reference to edit its details
  • Link Status โ€” Link status for each reference (linked/unlinked)

๐Ÿ“ฆ Exporting XML

Click the "Export XML" button in the editor top bar to export:

  • JATS XML โ€” An XML file conforming to the JATS 1.3 standard, ready to upload to OJS
  • Preview โ€” Preview the XML before downloading
  • Save Draft โ€” Save a draft to the server to continue later
๐Ÿ“Œ For OJS The exported XML file can be uploaded directly to Open Journal Systems (OJS) via the menu Galley โ†’ Add Galley โ†’ JATS XML.

โš ๏ธ Warnings Panel

Warnings Panel

The Warnings panel displays automatic validation checks on the document:

  • Cross-references to tables/figures that were not found
  • Citations not linked to any reference
  • Required metadata fields that have not been filled in
  • Inconsistent heading structure

โŒจ๏ธ Keyboard Shortcuts

ShortcutAction
โŒ˜ + EnterRun Hyperlinker (from the App page)
โŒ˜ + BBold
โŒ˜ + IItalic
โŒ˜ + UUnderline
โŒ˜ + โ‡ง + CInsert Citation Link

โ“ FAQ

Are my files safe?

Yes. Your files are processed on our server and automatically deleted after 24 hours. We do not store or share the contents of your documents.

How long does it take to process one file?

On average 30โ€“90 seconds, depending on the number of references. Files with 50+ references may take longer due to DOI lookup via CrossRef.

Why are there "unmatched refs"?

Unmatched references typically occur because: (1) Inconsistent citation formatting within the document, (2) References that are not cited in the body text, or (3) References from non-standard sources (legislation, websites, etc.).

What citation formats are supported?

30+ international citation styles including APA, Chicago, IEEE, Vancouver, Harvard, MLA, OSCOLA, Turabian, Bluebook, and more. See the Citation Styles section for the full list.

How do I purchase quota?

Contact us via email admin@ascarya.or.id to purchase a package.

Can it be used for non-OJS journals?

Yes. The generated JATS XML follows the international JATS 1.3 standard and is compatible with OJS, PubMed, Crossref, and other systems that support JATS.

๐Ÿ“ง Contact & Support

ChannelDetail
Emailadmin@ascarya.or.id
Websiteascarya.or.id

For bug reports, technical questions, or feature requests, please contact us via email.