Historium

A chronological timeline created from notes with the specific tag or combination of tags

Table of Contents

About The Project
Usage
- Creating a Timeline
- Dates
- Titles
- Description
- Image
- Types
- Color
- Path
- Groups and Nested Groups
Roadmap
Contributing
License
Acknowledgments

About The Project

Historium is a tool that allows you to create and visualize a timeline of your notes based on the tags you assign to them. You can use Historium to organize your notes by date, topic, category, or any other criteria you choose. Historium will automatically generate a chronological timeline of your notes with the specified set of tags, and display them in a user-friendly interface.

Usage

Properties:

how a typical event Property might be set up as

Creating a Timeline

To render a timeline in a note, you can use either the horizontal or vertical timeline format:

Horizontal Timine:

    ```timeline-vis
    (list of tags would go here, mainly a timeline tag)
    ```

Vertical Timeline:

    ``` timeline
    (list of tags would go here, or just leave it blank to gather all events)
    ```

Date:

The date is the most essential information for the timeline entry. It is specified as YEAR-MONTH-DAY. All four segments must be present and can contain only numbers, but can be any length. The YEAR (first segment) can be negative.

-123-45-678 is a valid date.

Segments containing leading or trailing zeros will be omitted when the timeline is generated, for example:

2300-02-00-00 will display as 2300-2
2300-00-00-00 will display as 2300
0023-02-10-00 will display as 23-2-10

Title:

The title is optional. If not specified, the name of the note will be used.

Description:

The description is also optional. It adds text to the Vertical Timeline Card to serve as a summary of the event.

Background Image:

You can optionally specify a background image for each event. If an image is not specified or an invalid URL is given, no image will be shown.

Indicator:

Indicators are optional badge-like icons added to the events to help distinguish or represent what the event is. The supported indicators currently are shown below:.


Horizontal Timeline	Vertical Timeline

Type:

The type property tells the timeline how each event should be displayed.

Note: Acceptable values for data-type are:

background, best used for time periods
box, idenify any extreme outlier, or important event
point, which is exactly what it sounds like, and
range, a way to show a span of extent of the event

Color:

Acceptable values for color useage are:

blue, green, gray, orange, pink, purple, red, yellow, white

Path:

The path property is optional and allows you to specify an alternate path to link the event to, but you can use this to specify other notes or link to headers or blocks internally within the note.

path: [[My Note#SubHeader]] would link directly to the Event Subheader in My Note

Groups and Nested Groups:

Groups allow you to categorize events together on their own line in the timeline. This feature leverages vis-timeline’s groups and nested groups functionality to provide a more organized view of events.

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Thank you for your interest in this project.

If you want to improve this project, you can fork the repo and create a pull request with your changes. You can also open an issue with the label "enhancement" to share your feedback or ideas. Please show your support by giving the project a star! I appreciate your collaboration!

To contribute to this project, follow these steps:

Fork the repo
Create a new branch on your local machine
```
git checkout -b Development/Historium
```
Make your changes and commit them
```
git commit -m 'Added some Feature'
```
Push your branch to GitHub
```
git push origin Development/Historium
```
Create a pull request and wait for review

License

See LICENSE.txt for more information.

Acknowledgments

Credit to

(back to top)