Class: Howdoc::Registry::Record

Inherits:
Struct
  • Object
show all
Defined in:
lib/howdoc/registry.rb

Overview

A guide as it appears in the index. It answers to the same readers a live Howdoc::Document does, so configuration hooks work with either.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#heading ⇒ Object

Returns the value of attribute heading

Returns:

  • (Object) —

    the current value of heading



30
31
32
 
# File 'lib/howdoc/registry.rb', line 30

def heading
  @heading
end

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



30
31
32
 
# File 'lib/howdoc/registry.rb', line 30

def id
  @id
end

#locale ⇒ Object

Returns the value of attribute locale

Returns:

  • (Object) —

    the current value of locale



30
31
32
 
# File 'lib/howdoc/registry.rb', line 30

def locale
  @locale
end

#permalink ⇒ Object

Returns the value of attribute permalink

Returns:

  • (Object) —

    the current value of permalink



30
31
32
 
# File 'lib/howdoc/registry.rb', line 30

def permalink
  @permalink
end

#title ⇒ Object

Returns the value of attribute title

Returns:

  • (Object) —

    the current value of title



30
31
32
 
# File 'lib/howdoc/registry.rb', line 30

def title
  @title
end

Instance Method Details

#filename ⇒ Object 



31
32
33
 
# File 'lib/howdoc/registry.rb', line 31

def filename
  "#{permalink}.html"
end