Giter Club home page Giter Club logo

Comments (3)

rkratky avatar rkratky commented on August 19, 2024

@vikram-redhat, only the UI elements macros (kbd, menu, btn) require the experimental attribute. Given that ccutil (and the CP) fully supports (i.e. renders well) these macros, the team that worked on these conventions did not consider their use optional. The macros improve semanticity of the source and as such are preferred over non-semantic mark-up.

from asciidoc-markup-conventions.

vikram-redhat avatar vikram-redhat commented on August 19, 2024

@rkratky - thanks. I wasn't referring to the UI elements macros, but to the others which are not yet part of the AsciiDoc conventions. The use of the experimental attribute was totally coincidental, but that is an interesting conversation as well.

I was referring to: command, package and filename. These are not standard AsciiDoc tags?

from asciidoc-markup-conventions.

rkratky avatar rkratky commented on August 19, 2024

I was referring to: command, package and filename. These are not standard AsciiDoc tags?

Got it, apologies for the misunderstanding.

The mark-up you're referring to is actually valid AsciiDoc(tor) syntax, and there's nothing experimental about it. AsciiDoc allows setting arbitrary/ad hoc class attributes using the [class]#element# syntax. See http://asciidoctor.org/docs/user-manual/#custom-styling-with-attributes

We're merely making use of this functionality to semantically mark up our source code, so that tools for automated docs testing, such as Emender, can easily pick up these elements and perform their checks.

from asciidoc-markup-conventions.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.