Skip to content

Decide on the exact formatting of links in Additional resources #4110

@aneta-petrova

Description

@aneta-petrova

Raised in #4096 (comment)

Per https://github.com/jhradilek/asciidoctor-dita-vale:

In DITA 1.3, the element can only contain links. Format additional resources as an unordered list, remove lines that do not contain a link or a cross reference, and remove any text that precedes or follows a link or a cross reference.

This is a significant diversion from how we currently adds links. For example, our current convention says this:

  • {AdministeringDocURL}Logging_and_Reporting_Problems_admin[Logging and reporting problems] in {AdministeringDocTitle}

(the target doc title is outside of the link label)

Possible solutions could be this:

  • {AdministeringDocURL}Logging_and_Reporting_Problems_admin[Logging and reporting problems in {AdministeringDocTitle}]

(the target doc title is part of the link label)

or this:

  • {AdministeringDocURL}Logging_and_Reporting_Problems_admin[Logging and reporting problems]

(no mention of the target doc title or website)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions