Code Monkey home page Code Monkey logo

yellow-diary's Introduction

Diary 0.9.1

Events diary.

Screenshot

How to install an extension

Download ZIP file and copy it into your system/extensions folder. Learn more about extensions.

How to show an events list

Create a [diary] shortcut.

The following arguments are available, all but the first argument are optional:

Name = file name of events list
TimeSpan = show future or past events
Max = number of events to show per shortcut, 0 for unlimited
Tags = show events with specific tags, wrap multiple tags into quotes

If you want to customise the events with CSS, write a diary-custom.css file, put it into your system/themes folder, open file system/extensions/yellow-system.ini and change DiaryStyle: custom.

How to create an events list

Put one or more events files into media/diary/. You can use YAML, PSV, TSV and CSV format, choose whichever you like better.

Events in a .yaml file (each event begins with ---; label is used to disambiguate between events occurring on the same date):

---
date: YYYY-MM-DD
start: HH:MM
end: HH:MM
label: text
place: text
description: text
tags: tag tag...

Events in a .psv file (one event per line):

YYYY-MM-DD | HH:MM | HH:MM | label | place  | description | tags

Events can be written also in a .tsv or a .csv format.

To add a poster to an event, put it in media/diary/posters/ with the name YYYY-MM-DD-label.pdf. To add an image different from the poster thumbnail, put it in media/diary/thumbnail/ with the name YYYY-MM-DD-label.jpg and a timestamp newer than that of the poster.

In place and description, use * for italic, ** for bold, [text](URL) for linking, \n for newline. Other URLs and email addresses are autolinked. In place, enclose an address in square brackets (e.g. Galleria degli Uffizi, [Piazzale degli Uffizi 6, Firenze]), or write GPS coordinates in brackets (e.g. Galleria degli Uffizi, Piazzale degli Uffizi 6, Firenze [43.7684,11.2556]), in order to add a link to a pop-up map.

Since the year of the events is not displayed, keep the events of each year in a different file and provide with an appropriate heading the page where you embed the diary.

Examples

Content file with events list:

---
Title: Example page
---
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut 
labore et dolore magna pizza. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris 
nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit 
esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt 
in culpa qui officia deserunt mollit anim id est laborum.

[diary events2019.psv]

Showing an events list, different files:

[diary events2019.psv]
[diary events2019.yaml]
[diary events2019.csv]

Showing an events list, various options:

[diary events2019.psv past]
[diary events2030.yaml future 5]
[diary events2030.yaml future 0 philosophy]

Settings

The following settings can be configured in file system/extensions/yellow-system.ini:

DiaryLocation = directory for diary files
DiaryPosterLocation = location for posters
DiaryThumbnail = show thumbnails, 1 or 0
DiaryThumbnailLocation = location for thumbnails
DiaryMaps = which map service is used, openstreetmap or googlemaps
DiaryCalendar = include link for iCalendar, 1 or 0
DiaryCalendarLocation = location for iCalendar files
DiaryStyle = diary style, e.g. plain, squared, rounded

Developer

Giovanni Salmeri. Get help.

yellow-diary's People

Contributors

giovannisalmeri avatar markseuffert avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

yellow-diary's Issues

No translation

Hi Giovanni,

I just installed the diary and al works fine except the Translations.
Bildschirmfoto 2022-12-06 um 14 53 10

I edited the language in the yellowsystems.ini from de to en but nothing has changed. I'm running Yellow 0.8.21.

Events not shown ...

Uuuups - SOLVED. Calendar files must be located in /media/diary not /media/diary/icalendar ... ;-)

Hello Giovanni,
playing around first time with Yellow and Trying your extension "diary": Clean install of Yellow (0.8.20) and using your examples:

[diary events2019.psv past]

but no success: "No events are shown.
Creating an own PSV-Table: no success. (Chrome, Chromium, Firefox, no matter what paramters given to the shortcut)

Is there a logging or: what could be wrong? Thanks!

Formatting in the description

Hi Giovanni,

I'd like to write the event descriptions in HTML or at least with the Markdown available in Yellow to be able to do formatting. I noticed your function toHTML($text) and wondered if it would be possible to use Yellow's Markdown function instead?

Background: I currently need <blockquote> and line breaks (including blank lines) for some events.

Thanks in advance
Robert

Fatal error

Dear Giovanni,

I gave your diary extension a shot on my website james-joyce.de.

Unfortunately, while on localhost, I ran into fatal errors and array errors, depending on which example data I used (csv or psv).
I have a feeling that the code does not quite match current Yellow standards, but I might be wrong.

Do you plan to update anytime soon?

Cheers, Carsten

Not an issue, more a feature request

Hi Giovanni,

on my Joyce website, I have events that are not scheduled. What I mean is there are "continuous" events (like reading groups for Ulysses) without a fixed "date" (like 2024-12-01), nor "start" and "end" time. Sometimes, I know that events like the Trieste Joyce School programme will take place in the summer of 2024, but they have not yet scheduled an exact date, Sometimes, the event (an exhibtion, for example) will last for a certain time span (like Bloomsday, 11-16 June 2024)-

Would it be difficult to add a loop that checks is date: 2024-00-00 and start&end: 00:00 and then outputs just the year "2024"?

Cheers,

Carsten

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.