Documentation

You should instantiate MultiTag to a tag associated to the structure you are working with. The tag is mostly there to prevent orphan instances, since people are often working with structures from other packages (Pandoc AST, HTML, etc.)

Query a structure with a single query function (just like Pandoc.Walk).

Modify a structure by walking with a single function (just like Pandoc.Walk).

Modify a structure by walking with a single function (just like Pandoc.Walk).

Modify (only) substructures by applying functions from FList.

Query (only) substructures by applying functions from QList.

Most general way to create a walk. Create a walk with multiple functions, targeting multiple types.

First argument is a function that takes a walk, an empty list of functions and should return a list of functions populated with the multiple walk functions.

By "tying a knot", the first argument you are supplied with is almost the result of buildMultiW itself, the only difference being that it only walks substructures of the type. It's a responsability of each function in the FList to apply this function to its argument in any desired way, as to continue recursing down the "type tree".

You can add functions to the empty FList via .>.

multi :: Applicative m => Block -> m Block
multi = buildMultiW @PTag $ \sub list ->
    list .> blks sub
         .> inls sub
  where
    blks _ (CodeBlock _ c) = Para [Str c]
    blks f x = f x
    inls _ (Code _ c) = Str c
    inls f x = f x

Most general way to create a query. Create a query with multiple functions, targeting multiple types.

First argument is a function that takes a query, an empty list of queries and should return a list of queries populated with the multiple query functions.

By "tying a knot", the first argument you are supplied with is almost the result of buildMultiQ itself, the only difference being that it only queries substructures of the type. It's a responsability of each function in the QList to apply this function to its argument in any desired way, as to continue recursing down the "type tree".

You can add functions to the empty QList via ?>.

multi :: Block -> [Text]
multi = buildMultiQ @PTag $ \sub list ->
    list ?> blks sub
         ?> inls sub
  where
    blks _ (CodeBlock _ c) = [c]
    blks f x = f x
    inls _ (Code _ c) = [c]
    inls f x = f x

Add a function to a FList.

Add a function to a QList.

Use this for matching with a type inside a traversable functor.

Use this for matching with another type that is coercible to the type you want.

Use this for matching a subcomponent nested inside another type. Useful if you don't want to add the middle type to the list of walkable types.

Heterogeneous list of monadic-valued functions

Heterogeneous list of queries