# Children

Arrr

Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.

Use th' children shorrrtcode t' list th' child planks o' a plank an' th' further descendants (children’s children). By default, th' shorrrtcode displays links t' th' child planks.

## Usage

Parameter | Default | Descript'n
--- | --- | ---
plank | current | Specify th' plank name (section name) t' display children fer
containerstyle | “ul” | Choose th' style used t' group all children. It could be any HTML tag name
style | “li” | Choose th' style used t' display each descendant. It could be any HTML tag name
showhidden | “false” | When true, child planks hidden from th' menu will be displayed
descript'n | “false” | Allows ye t' include a short text under each plank 'n th' list. When no descript'n exists fer th' plank, children shorrrtcode takes th' first 70 words o' yer rrrambl'n. Read more info about summaries on gohugo.io
depth | 1 | Enter a number t' specify th' depth o' descendants t' display. For example, if th' value be 2, th' shorrrtcode will display 2 levels o' child planks. Tips: set 999 t' get all descendants
sort | ordersectionsby | Sort children by weight, t' sort on menu order - title, t' sort alphabetically on menu label. If not set it be sorted by th' `ordersectionsby` sett'n o' th' ship an' th' planks frontmatter

## Demo

    {{% children  %}}

- plank X
- plank 1
- plank 2
- plank 3

    {{% children descript'n="true" %}}

- plank X

This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...

- plank 1

This be a demo child plank

- plank 2

This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.

- plank 3

This be a demo child plank

    {{% children depth="999" showhidden="true" %}}

- plank X

- plank 1

- plank 1-1

- plank 1-1-1 (hidden)

- plank 1-1-1-1

- plank 1-1-1-1-1 (hidden)

- plank 1-1-1-1-1-1

- plank 1-1-2

- plank 1-1-2-1

- plank 1-1-2-2

- plank 1-1-3

- plank 2

- plank 3

- plank 3-1

- plank 4 (hidden)

    {{% children containerstyle="div" style="h2" depth="3" descript'n="true" %}}

## plank X

This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...

## plank 1

This be a demo child plank

### plank 1-1

This be a demo child plank

#### plank 1-1-2

This be a demo child plank

#### plank 1-1-3

This be a demo child plank

## plank 2

This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.

## plank 3

This be a demo child plank

### plank 3-1

This be a plain plank test nested 'n a parent

    {{% children containerstyle="div" style="div" depth="999" %}}

plank X
plank 1
plank 1-1
plank 1-1-2
plank 1-1-2-1
plank 1-1-2-2
plank 1-1-3
plank 2
plank 3
plank 3-1