Apix-Calendar documentation

Foreword

Application

...Apix-Calendar is a free online Web-App : www.apixline.org/pm/app/web/html5/calendar/en.html
or on Firefox Marketplace
or on Google Play for Android mobiles.

It is open- source. Can be downloaded / forked : on github

This is the HTML5 version of a Flash web-app : www.apixline.org/pm/app/web/calendar/ (fr)
Flash version only works on desktop computers.
You can use currently both versions because they target the same database.

Warranty:
This application is provided "as is" without warranty of any kind.
If -by fatal case- online use would stop, apixline.org couldn't be held responsible or compensate users.
License:
GNU-GPL

Presentation

The first idea is to display full year (from december year-1 to January year+1) on one screen, to provide quick access to months and days .
So many months and days as desired can be opened at the same time and texts can be dragAndDroped.
Simple calendar if you aren't logged in, app. becomes an agenda/schedule by logging.
A note can be associated with a day of the month and/or the entire month.
The same URL works as well on mobiles than PC/Mac.
Layout adapts it-self to any kind of screens or browser's ratios.

This app is designed to run on a valid HTML5 browser.
Tested by me on :

recent versions of Chrome , Firefox and Safari browsers,
IE mobile v10 ,
Android: native & Firefox browsers, Htc smartphone and Acer tablet.

(!) Gradients aren't okay on Safari and native Android browser.

Notes

I use this calendar myself and backup regularly datas. But if you want to do it yourself, it is better to download and install the application on your web server.
Sql database isn't necessary, but PHP is required.
download...

Do not hesitate to leave me encouragement and let me know bugs. I will correct them as soon as possible (tell me where error occures: Mobile, PC or Mac and the browser's name) :
email
Twitter

If this application please to you , talk about it around you :)

English is not my mother language as you can see... As Droopy says, I'd be an happy taxpayer, if a real english speaking corrects this documentation for me :)

Recommendations:

Orientation "portrait" is better on smartphones and tablets.
On a large width tablet in landscape-mode, the layout is the same as PC/Mac. But the portrait-mode seems still preferable to me.
Apix -Calendar is very simple and intuitive to use, but
it is advisable to read at least bold texts of user-guide below.

Confidentiality

Confidentiality is highly respected :
This application asks you only a name and password for each created calendar. Email is recommended but facultative.
Emails are stored on a private server that I physically control. They aren't related to texts (or nothing else !).

Names and passwords are not stored in plaintext but coded ;
There is no way (including for me) to link a text to a name because impossible to find a name from its code.
(as explained below, the contrary is fortunately possible).
The counterpart is that you must remember at least the name that you created.
If you lose password, I can with your name, retrieve the data and give you access to it: info@pixaline.net

User guide

Start

On 1st launch (when no session is open) a dialog-box offers you to sign in or sign up. (see § SignUp).

If you don't want to create your personalized calendar
Click on "Cancel" :
The window will disappear and you can just:
View all months and days with full dates, as on a traditional calendar,

...or finally decide to create your agenda by clicking the "SignIn/SignUp" button.

Sign Up

Registration allows you to create your own schedule or agenda, to enter notes for a day or a month.
To register:
Click on "SignIn/signUp".

a dialog-box appears, go to lower part.
Enter a name :
This name must be unique. If it is already taken by another user , an error message appears and you must select another one.

Its length must be from 3 to 10 characters.
It must contain only letters A to Z and numbers from 0 to 9.


This may be a pseudonym, your name or the name of the calendar if you like to create many of them.

Enter a password:
Its length must be from 6 to 10 characters .

Confirm password:
If passwords are different an error message appears.

Click on bottom button "OK" .
Your personal calendar is created !
A last dialog box offers you to send your email to receive updates and news from my other applications.
You can leave this field blank and confirm.
Otherwise :
This email will never be disclosed and it is not stored on the Internet.

Notes:
Confidentiality is highly respected :

Emails are stored on a private server that I physically control. They aren't related to texts (or nothing else !).
Names and passwords are not stored in plaintext but coded ;
There is no way (including for me) to link a text to a name because impossible to find a name from its code.
(as explained below, the contrary is fortunately possible).

The counterpart is that you must remember at least the name that you created.
If you lose password, I can with your name, retrieve the data and give you access to it.

Sign In

Of course, you have to create one or more account(s) before to connect you.

At startup or by clicking on "SignIn/signUp" a dialog-box appears:
In upper part : Enter name and password then click on "Enter" button.
Dialog-box closes: The name appears in the subtitle after the current year.
The "LogOut" button replaces "SignIn/signUp"
The "Settings" button appears.
You can enter text or change settings: connection's security, new year (see chapters below).

Settings

You must to be logged to access to settings .
Click the " Settings" button
The dialog-box which appears contains two parameters.

1_ Security password:
Name and password are not stored locally : the connection is secure
(see § "Security" below) .
To switch operation mode from "secure" to "unsecure" and reciprocally , click on button of the window top.

2_ Changing the current year:
Starting, the current year is the system's year . After, this is the one you choose.
Enter a new 4-digits year and confirm :
The months and days of the new year will be displayed.
Data for other years are not lost.
The data for January and December respectively preceding and following the current year are included .
You can always go on the year of your choice without data loss.

Year is saved and will be current year of next connection.


Notes:
If you close a calendar (log out) then create immediatly a new one (sign up) : it will have the same default year than the closed calendar.
If you create a new calendar after page refreshing : it will have the system year as default year.

Text content

You must be logged to create notes .

Inputting notes (post-it) is free, there is no time slot.
Several notes can be opened at the same time, be dragged/dropped.

At start, every month is visible but closed (days are hidden) except the current month -if the current year is same as system's year.

To open a month
Click on month's bar.
It will be positioned at the top of the screen,
days appear.

To open a day.
click on the day's bar.
It will be positioned at the top of the screen,
the full date will be visible in the day's bar.
the note will appear :
"Clear" button = > Text content disappears, the note remains "open"
"Cancel" button = > Any modification or clear is canceled, the note is closed.
"Enter" button = > Change is saved , the note is closed.

To close a day .
click again on the day's bar.
Text content will be registered if it has been modified,
note disappear,
the beginning of the text will be displayed in the day's bar
day's bar stays in place on mobiles or return to its original place on PC/Mac browsers.

To close a month
Click on the month's bar.
Days disappear,
days which were open remain open at next month's opening.
month's bar stays in place on mobiles or return to its original place on PC/Mac browsers.

To open whole month's note :
Click on the pictogram representing a "Post-it" -on the right of the month's bar.
Pictogram is "normal" when note is empty and "scrawled" when note contains text.
Month will be positioned at the top of the screen,
note will appear :
"Clear" button = > text content disappears but the note remains "open"
"Cancel" button = > Any modification or clear is canceled, the note is closed.
"Enter" button = > Change is saved , the note is closed.

To close whole month's note :
click again on the "Post-it" pictogram.
Text content will be registered if it has been modified,
note disappear,
month's bar stays in place on mobiles or return to its original place on PC/Mac browsers.
"Post-it" pictogram is updated .


Note: Clicking a month's bar, displays/hides the days but not month's note and reciprocally.

Security

Connection:

If you stay a while without doing anything or without submit changes (text, year, etc. )
the server automatically logouts you (time-out). At next submission you will be prompted to loggin again.
In secure mode, you must enter name and password each time.
In unsecured (see § "Settings" above) name and password are provided by default in the login dialog-box.
They need to be saved on your computer. Cookies must be allowed by your browser settings.
Note:
Application's security system does not change the behavior of your browser which also may or may not have default prompts.

Autosave of text contents :

Regularly modified text contents are automatically recorded.
The trigger delay after your last validation is 3 minutes.
In other words if you submit -or close- notes just after modification, automatic backup will never trigger.

In case of "time-out" (see above) after click "enter": the last entry is retrieved.

Generally, application tends to automatically save changes rather than lose them !
So it's better to :
Click on "Cancel" as soon as you want to cancel a change.
Avoid to leave application with lots of unstable open notes.

Log out

You must be logged in to log out.   (Sorry, I could not prevent myself to do it !)

Click on top/left logOut button.

If one or more modified notes, haven't been saved:
A warning dialog-box appears.
By clicking "Save posts":
Texts will be saved and log-out will be canceled (you must press "logOut" button again).
By clicking "Confirm"
You will be disconnected without texts saving.

After log-out, the application switches to "simple calendar" :
Every month is open by default -only on PC/Mac's large screens.
full dates are visible, days aren't anymore interactive,
the "settings" button disappear.

Links