New CompiledJournalEntry

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

New-CompiledJournalEntry

SYNOPSIS

Aggregates a collection of journal entries into a new, individual journal entry.

SYNTAX

Default (Default)

New-CompiledJournalEntry [-From <DateTime>] [-To <DateTime>] [-Tags <String[]>] [-AllTags] [-Location <String>]
 [<CommonParameters>]

Entries

New-CompiledJournalEntry -Entries <PSObject[]> [-Location <String>] [<CommonParameters>]

DESCRIPTION

Aggregates a collection of journal entries into a single compiled entry. The input entries can be filtered by tags, date range, or a custom query. The resulting compiled entry contains all the selected journal entries in a single document, laid out in sequential order based on the creation date of the input entries. This allows you to dynamically assembly new journal entries, composed of previous entries, so that they can be read in new and interesting ways.

EXAMPLES

Example 1

PS C:\> New-CompiledJournalEntry -Tags vacation,germany -AllTags

Creates a new compiled entry based on all previous non-compiled entries which were tagged both germany and vacation.

Example 2

PS C:\> New-CompiledJournalEntry -Tags big-event -From '2019.1.1'

Creates a new compiled entry based on entries originally written between January 1, 2019 and today which were taggedbig-event.

PARAMETERS

-AllTags

Requires that selected journal entries include all tags provided in the -Tags parameter. By default, entries are selected if they contain any of the tags specified by the -Tags parameter.

Type: SwitchParameter
Parameter Sets: Default
Aliases:

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

-Entries

An array of IJournalEntry objects to be combined into a single journal entry. These objects can be generated using the Get-journalIndex or Get-JournalEntriesByTag cmdlets. See the examples for more information.

Type: PSObject[]
Parameter Sets: Entries
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-From

Filters included journal entries to those which were written on or after the specified date.

Type: DateTime
Parameter Sets: Default
Aliases:

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

-Location

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

-Tags

An array of tags used to filter the collection of journal entries

Type: String[]
Parameter Sets: Default
Aliases:

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

-To

Filters included journal entries to those which were written on or before the specified date.

Type: DateTime
Parameter Sets: Default
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

System.Management.Automation.PSObject[]

OUTPUTS

System.Object

NOTES

RELATED LINKS