Skip to content

Latest commit

 

History

History
76 lines (63 loc) · 1.28 KB

fields.md

File metadata and controls

76 lines (63 loc) · 1.28 KB

Fields and Subfields

Most properties (in dicts / objects) can be queried using normal field syntax. For lists of dictionaries or objects, this will map the property of the list items to the parent list.

metadata.name # return a string
tags.name # return a list of tag names

Specific list items can also be accessed using their index.

tags.0

For dealing with nested arrays you can use the * (reduce) operator:

lists.*.text

Pages

title: str # filename without extensions
filename: str
abs_path: str
rel_path: str
created_at: datetime
modified_at: datetime
tags: list[Tag]
out_links: list[Link] # external links are not indexed for now
out_link_count: int
in_links: list[Link]
in_link_count: int
word_count: int
metadata: dict
headings: list[Heading]
outline: str
lists: list[list[ListItem]]

Headings

text: str
depth: int
children: list # not in use

Tags

name: str
count: int
docs: str[str] # absolute paths of source documents

ListItem

text: str
depth: int # indent level
type: str
status: Union[str,None]
children: list # not used
doc_abs_path: str

Links

text: str
href: str # the exact text of the link
href_resolved: str
doc_title: str
doc_abs_path: str
type: str # wiki or regular