Historium

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

Table of Contents

1. About The Project
2. Usage
   • Creating a Timeline
   • Dates
   • Titles
   • Description
   • Image
   • Types
   • Color
   • Path
   • Groups and Nested Groups
3. Roadmap
4. Contributing
5. License
6. 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.

(back to top)

Usage

Properties:

how a typical event Property might be set up as

(back to top)

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)
    ```

(back to top)

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

(back to top)

Title:

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

(back to top)

Description:

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

(back to top)

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.

(back to top)

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

(back to top)

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

(back to top)

Color:

Acceptable values for color useage are:

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

(back to top)

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

(back to top)

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.

(back to top)

Roadmap

• Add Changelog
• Redesign Vertical Timeline
• Redesign Horizontal Timeline
• Calendarium\Fantasy Calendar API Support
• Additonal Features
  • [/] Icons
  • Group support
    • Nested Group support

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

(back to top)

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:

1. Fork the repo

2. Create a new branch on your local machine

   git checkout -b Development/Historium

3. Make your changes and commit them

   git commit -m 'Added some Feature'

4. Push your branch to GitHub

   git push origin Development/Historium

5. Create a pull request and wait for review

(back to top)

License

See LICENSE.txt for more information.

(back to top)

Acknowledgments

Credit to

• 
• 

  (back to top)