Comments (3)
@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.
@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.
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)
- Add supported syntax highlighting formats HOT 2
- Add links to AsciiDoc(tor) user manual and mark-up reference HOT 1
- Add intro paragraph HOT 2
- Edit text to say 'Click' instead of 'Press' HOT 1
- Add 'Inline Icons' to this list
- Fix link to mod docs guide
- nbsp for product names HOT 4
- Use of Italics for "System or software variable to be replaced by the user" HOT 8
- Product name
- the subtitle is not accurate HOT 2
- Incorrect example of emphasis for a term HOT 3
- Keyboard shortcut example doesn't match IBM Style HOT 1
- Double underscore for italics surrounded by chevrons (aka pointy brackets)
- {nbsp} in Command Block HOT 1
- Needs to be more robust HOT 5
- Update the 'Reference to Red Hat guides' example HOT 1
- Update the 'System or software variable to be replaced by the user' example ad markup used HOT 1
- Update the 'Anchor' example HOT 3
- Add context description to clarify purpose of this resource
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from asciidoc-markup-conventions.