Package org.asciidoctor.extension

Annotation Type Location

  • @Documented
@Retention(RUNTIME)
@Target(TYPE)
public @interface Location
    This annotation defines the location where the content created by a DocinfoProcessor will be added.

    The following example will add a robots meta tag to the head element of the resulting HTML document: 

     
 @Location(LocationType.HEADER)
 class RobotsDocinfoProcessor extends DocinfoProcessor {

     public static final String META_TAG = "<meta name=\"robots\" content=\"index, follow\"/>";

     public String process(Document document) {
         return META_TAG;
     }
 }

    Applicable for:

    BlockMacroProcessor
    BlockProcessor
    BlockProcessor
    DocInfoProcessor✓
    IncludeProcessor
    InlineMacroProcessor
    Postprocessor
    Preprocessor
    Treeprocessor

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      LocationType value  

    • Element Detail

      • value

        LocationType value
        Default:
        org.asciidoctor.extension.LocationType.HEADER