-
Notifications
You must be signed in to change notification settings - Fork 5
Get JournalReadmeEntries
external help file: JournalCli.dll-Help.xml
Module Name: JournalCli
online version:
schema: 2.0.0
Lists readme entries which are due to be re-read.
Get-JournalReadmeEntries [-All] [-Location <String>] [<CommonParameters>]
Get-JournalReadmeEntries [-Period <String>] [-Duration <Int32>] [-Location <String>] [<CommonParameters>]
Retrieves a list of all readme journal entries which are due to be re-read. More precisely, it returns entries that have a readme date on or before today. The list can be limited to entries which became due for re-reading within a certain range of time, such as over the last year or 18 months.
> Get-JournalReadmeEntries -Period Years -Duration 1 | Format-List
ReadmeDate : Saturday, August 27, 2019
Headers : {## ReadMe:}
EntryName : 2019.08.27
Tags : {work, exercise}
ReadmeDate : Saturday, August 1, 2019
Headers : {## Car broke down, ## The evening}
EntryName : 2019.08.23
Tags : {work, event, predictions}
ReadmeDate : Sunday, January 26, 2019
Headers : {# Thursday, September 26, 2019}
EntryName : 2019.09.26
Tags : {coding, work}
# Notes:
# 1. This example is contrived, so the entry dates and readme dates may appear a bit odd.
# 2. Format-List is not required; It was used only for readability.Retrieves all readme entries which have elapsed over the past year.
Returns all readme entries which have elapsed prior to today. This is the default and does not need to be explicitly provided.
Type: SwitchParameter
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA number, greater than or equal to 1, which specifies the number of Periods to include in the results lists. This parameter can only be used in conjunction with -Period, documented below.
Type: Int32
Parameter Sets: Range
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: FalseSpecifies a period of time - Years, Months or Days - used to filter the number of readme entries returned. This parameter can only be used in conjunction with -Duration, documented above.
Type: String
Parameter Sets: Range
Aliases:
Accepted values: Years, Months, Days
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.