Asciidoctor :: Discussion

Definitive List of Asciidoctor Attributes

‹ Previous Topic Next Topic ›
 
classic Classic list List threaded Threaded
♦
♦
 5 messages Options
jnorthr
Reply | Threaded
Open this post in threaded view
♦
♦
|

Definitive List of Asciidoctor Attributes

jnorthr
could anyone pls offer a link to a complete list of the document metadata attributes available within a document, like author, firstname, lastname, etc. ?
thx
LightGuardjp
Reply | Threaded
Open this post in threaded view
♦
♦
|

Re: Definitive List of Asciidoctor Attributes

LightGuardjp
This may not be exactly what you're looking for, but hopefully it helps:

```ruby
"encoding"=>"UTF-8",
 "sectids"=>"",
 "notitle"=>"",
 "toc-placement"=>"auto",
 "stylesheet"=>"",
 "prewrap"=>"",
 "attribute-undefined"=>"drop-line",
 "attribute-missing"=>"skip",
 "caution-caption"=>"Caution",
 "important-caption"=>"Important",
 "note-caption"=>"Note",
 "tip-caption"=>"Tip",
 "warning-caption"=>"Warning",
 "appendix-caption"=>"Appendix",
 "example-caption"=>"Example",
 "figure-caption"=>"Figure",
 "table-caption"=>"Table",
 "toc-title"=>"Table of Contents",
 "manname-title"=>"NAME",
 "untitled-label"=>"Untitled",
 "version-label"=>"Version",
 "last-update-label"=>"Last updated",
 "docfile"=>"README.adoc",
 "docdir"=>"",
 "docname"=>"README",
 "docdate"=>"2013-04-27",
 "doctime"=>"21:21:48 MDT",
 "docdatetime"=>"2013-04-27 21:21:48 MDT",
 "asciidoctor"=>"",
 "asciidoctor-version"=>"0.1.4",
 "safe-mode-name"=>"secure",
 "safe-mode-secure"=>"",
 "safe-mode-level"=>20,
 "embedded"=>"",
 "max-include-depth"=>64,
 "backend"=>"html5",
 "linkcss"=>"",
 "doctype"=>"article",
 "backend-html5"=>"",
 "basebackend"=>"html",
 "basebackend-html"=>"",
 "html5-article"=>"",
 "html-article"=>"",
 "outfilesuffix"=>".html",
 "filetype"=>"html",
 "filetype-html"=>"",
 "localdate"=>"2014-02-11",
 "localtime"=>"15:36:41 MST",
 "localdatetime"=>"2014-02-11 15:36:41 MST",
 "stylesdir"=>".",
 "iconsdir"=>"./images/icons",
 "doctitle"=>
  "asciidoctor.org image:<a href="https://secure.travis-ci.org/asciidoctor/asciidoctor.github.com.png?branch=develop[\">https://secure.travis-ci.org/asciidoctor/asciidoctor.github.com.png?branch=develop[\"Build Status\", link=\"<a href="https://travis-ci.org/asciidoctor/asciidoctor.github.com\">https://travis-ci.org/asciidoctor/asciidoctor.github.com\"]"
```


On Tue, Feb 11, 2014 at 3:29 PM, jnorthr [via Asciidoctor :: Discussion] <[hidden email]> wrote:
could anyone pls offer a link to a complete list of the document metadata attributes available within a document, like author, firstname, lastname, etc. ?
thx

If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Definitive-List-of-Asciidoctor-Attributes-tp1431.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
graphitefriction
Reply | Threaded
Open this post in threaded view
♦
♦
|

Re: Definitive List of Asciidoctor Attributes

graphitefriction
Administrator
In reply to this post by jnorthr
I haven't documented all of the attributes yet :(
However, a list of *most* of the Asciidoctor attributes and values is in an Appendix of the User Manual: http://asciidoctor.org/docs/user-manual/#asciidoctor-vs-asciidoc.

You can then search the User Manual for the definition/example of that attribute or value (if I've documented it).

Cheers,

Sarah
asotobu
Reply | Threaded
Open this post in threaded view
♦
♦
|

Re: Definitive List of Asciidoctor Attributes

asotobu
Interesting because I may need to update some of them in AsciidoctorJ so can be set externally.
mojavelinux
Reply | Threaded
Open this post in threaded view
♦
♦
|

Re: Definitive List of Asciidoctor Attributes

mojavelinux
Administrator
Alex,

We don't necessarily want all of those attributes propagated. There are a handful that are there for legacy / compatibility reasons that we don't really want to expose or promote usage of. Perhaps a column (or indicator) in the user manual for which attributes are deprecated or internal would be helpful.

All,

You can see all the attributes that get set when the document is parsed using:

```ruby
require 'asciidoctor'
require 'pp'

doc = Asciidoctor.load_file 'sample.adoc', safe: :safe

pp doc.attributes
```

If there's an attribute that isn't documented, please feel free to submit a pull request...even if it's just to add the row with no description.

Cheers,

-Dan


On Tue, Feb 11, 2014 at 4:12 PM, asotobu [via Asciidoctor :: Discussion] <[hidden email]> wrote:
Interesting because I may need to update some of them in AsciidoctorJ so can be set externally.

If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Definitive-List-of-Asciidoctor-Attributes-tp1431p1434.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Free forum by Nabble Edit this page