Creating a new AsciiDoc File in IntelliJ IDE

Video Walkthrough

Coming Soon

File Names

A file’s name is used to create its page URL. Changing a file’s name will break links, cross-references (xrefs) in other files, and incoming links to the page from external websites.

When a file name is changed all cross-references (xrefs) links in all other policy files would need to be updated to the new name. This is why it is important that the file name be correct when initially created.

FILE NAME REQUIREMENTS:

  • Use all lowercase letters.

  • Do not use blank spaces. Separate words with hyphens.

  • Save AsciiDoc files with the .adoc extension.

  • Do not use symbols or special characters.

  • Do not include references to a version of the file in the File Name.

    • For example, 3000-v1.adoc or 3000-9-20-2024.adoc

Steps

  1. In IntelliJ IDE open the Project you need to create a new file in.

Please ensure you have the correct branch open to perform any updates.

  1. In the file folder view section of IntelliJ navigate to the correct folder. This will typically be the pages folder for Policy Updates.

  2. Right-click on that folder to open the context menu, expand the New section, and select AsciiDoc File

    train new file 1

  3. This will generate a prompt to enter the file name. Please ensure the file name follows the requirements outlined above.

    train new file 2

  4. Once you have entered the file name press the Enter key to create the new file.

  5. This will generate a prompt to add the file to the Git. Click Add button to add the file to the repository. train new file 3

  6. This will open the newly created blank AsciiDoc page.

  7. To create the Title enter the = and a space and type in the Title of the new page and add any of the required attribute fields.

Example AsciiDoc Header
= 2000 General Program Overview
:chapter-number: 2000
:effective-date: December 2022
:mt: MT-68
:policy-number: 2000
:policy-title: General Program Overview
:previous-policy-number: MT 57