Get JournalIndex

---

external help file: JournalCli.dll-Help.xml Module Name: JournalCli schema: 2.0.0

Get-JournalIndex

SYNOPSIS

Dynamically creates an index of all journal entries.

SYNTAX

Get-JournalIndex [-OrderBy <String>] [-Direction <String>] [-IncludeHeaders] [-RootDirectory <String>]
 [<CommonParameters>]

DESCRIPTION

Dynamically creates an index of all journal entries by tag and count. Use this to see which tags have been used, how often the tags have been used, and to which journal entries tags have been applied. This index is always created on the fly and is never cached.

EXAMPLES

Example 1

PS C:\> Get-JournalIndex

Tag          Count Entries
---          ----- -------
work           120 {2018.01.08, 2018.01.09, 2018.01.10, 2018.01.11…}
vacation        42 {2018.01.26, 2018.01.27, 2018.01.28, 2018.01.29…}
family          36 {2018.01.13, 2018.02.21, 2018.02.24, 2018.02.26…}
relaxing        33 {2018.01.06, 2018.01.07, 2018.01.11, 2018.01.13…}
big-event       32 {2018.01.16, 2018.01.25, 2018.03.02, 2018.04.13…}
coding          28 {2018.02.22, 2018.02.26, 2018.03.03, 2018.03.04…}
work-drama      20 {2018.01.24, 2018.03.15, 2018.04.13, 2018.04.14…}

A truncated view of a journal index.

PARAMETERS

-Direction

The sort order.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Ascending, Descending

Required: False
Position: Named
Default value: Descending
Accept pipeline input: False
Accept wildcard characters: False

-IncludeHeaders

Includes the collection of headers that exist in each journal entry. Headers are defined as lines that begin with a # character. This is useful if you write journal entries that include headers for different subtopics.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-OrderBy

The sort field.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Count, Name

Required: False
Position: Named
Default value: Count
Accept pipeline input: False
Accept wildcard characters: False

-RootDirectory

The root directory for the journal to search for entries. This is only required if no default journal location has been set, or to search a non-default location.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

JournalCli.JournalIndex

NOTES

RELATED LINKS