Difference between revisions of "Documentation:The Editor and data format"

Jump to navigation Jump to search

Documentation:The Editor and data format (edit)

Revision as of 21:15, 7 March 2022

1,622 bytes removed ,  21:15, 7 March 2022
m
79 revisions imported
m (79 revisions imported)
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
Let’s see how the information about events is stored on the server. Make sure that the library is open (click ‘Events’ button in the bottom right corner of the screen if needed)
Let’s see how the information about events is stored on the server. Make sure that the library is open (click ''Events'' button in the bottom right corner of the screen if needed)


Then open Menu (click ‘Menu’ button in the bottom left corner of the screen). Now select ‘Show Cache and Edit buttons’.  
Then open Menu (click ''Menu'' button in the bottom left corner of the screen). Now select ''Show Cache and Edit buttons''.  


[[File:ShowCacheAndEditButtons.png]]
[[File:ShowCacheAndEditButtons.png]]


You should see that Cache and Edit buttons have appeared in the Library next to each folder and layer of edits.
You should see that ''Clear cache'' and ''Edit'' buttons have appeared in the Library next to each folder and layer of events.


[[File:CacheAndEventButtons.png]]
[[File:CacheAndEventButtons.png]]


Click an Edit button next to some layer, and another Edit button next to some folder. Pages with wikitext should open in separate tabs. Examine the data and compare it to what you see on the timeline. Here is an example for a [https://historytimeline.app/wiki/index.php?title=HistoryTimelineLayer:Kings%20of%20Rome&action=edit layer]. Here is an example for a [https://historytimeline.app/wiki/index.php?title=HistoryTimelineFolder:Ancient%20Rome&action=edit folder].
Click an ''Edit'' button next to some layer, and another ''Edit'' button next to some folder. Pages with wikitext should open in separate tabs. Examine the data and compare it to what you see on the timeline. Here is an example for a [https://timeline.oldera.org/wiki/index.php?title=HistoryTimelineLayer:Kings%20of%20Rome&action=edit layer]. Here is an example for a [https://timeline.oldera.org/wiki/index.php?title=HistoryTimelineFolder:Ancient%20Rome&action=edit folder].


Let's look at this example:
Let's look at this example:
Line 20: Line 20:


==The Editor==
==The Editor==
There should be a button called ‘Editor’ in the bottom left corner of the screen next to the Menu button. If you don’t see it, it’s because the browser window is too small to fit the Editor. On a desktop try making the browser window fullscreen. If you have a small-screen device like a mobile phone, you won’t be able to use the Editor.
There should be a button called ''Editor'' in the bottom left corner of the screen next to the Menu button. If you don’t see it, it’s because the browser window is too small to fit the Editor. On a desktop try making the browser window fullscreen. If you have a small-screen device like a mobile phone, you won’t be able to use the Editor.


Open the Editor. Let's add a couple of events, like so:
Open the Editor. Let's add a couple of events, like so:
Line 38: Line 38:
There are 7 data fields for each event:
There are 7 data fields for each event:


[[File:DataFormat.png]]
[[File:NewDataFormat.png]]


Some data fields are used by one kind of event but not the other. Others are used by both.
Some data fields are used by one kind of event but not the other. Others are used by both.
Let’s go through all of the data fields one by one.
Let’s go through all of the data fields one by one.


''Visible text'' - for time intervals try to put short titles here, not whole sentences. You can use the ''Comment'' field to put longer text there.  
''Visible text'' - for time intervals try to put short titles here, not long sentences. You can use the ''Comment'' field to put longer text there.  
For instantaneous events the text can be longer, but don’t put entire articles there. One or two sentences should suffice.
For instantaneous events the text can be longer, but don’t put entire articles there. One or two sentences should suffice.
You can use some of the features of Wikipedia’s wikitext in the cards. For example, to add a link, use double brackets.  
You can use some of the features of Wikipedia’s wikitext in the cards. For example, to add a link, use double brackets.  
Line 101: Line 101:
[[File:VisibleDynasty.png]]
[[File:VisibleDynasty.png]]


''Link'' - this field is only used for time intervals. By default the visible text of the time interval is the link to the corresponding Wikipedia page. If you want the link to be different from the visible text, specify the actual link in this field. If you want to link to a page outside of Wikipedia, use the full link (which starts with http or https). If you don't want the text to be a link at all, put a hyphen in the ''Link'' field. The text in this case will become grey instead of white and will not be clickable.  
''Link'' - this field is only used for time intervals. By default the visible text of the time interval is the link to the corresponding Wikipedia page. If you want the link to be different from the visible text, specify the actual link in this field. If you want to link to a page outside of Wikipedia, use the full link (which starts with http or https). If you don't want the text to be a link at all, put a minus sign <code>-</code> in the ''Link'' field. The text in this case will become grey instead of white and will not be clickable.  
 
''Custom dates'' - this field is only used for time intervals. By default every time interval has a range of years specified under its title.
 
[[File:Rebel.png]]
 
Those years are automatically taken from the ''Start date'' and ''End date'' fields.
 
<code>Jean-Féry Rebel;;;;04.18.1666;01.02.1747;</code>
 
But what if you want to provide more details. For example, sometimes you want to have something like this:
 
[[File:CharlesDolle.png]]
 
 
That’s what the ''Custom dates'' field is for. Simply specify whatever you want to see in the second line there.
<code>Charles Dollé;;(fl. 1735–1755\; d. after 1755);;1735;1755;</code>
 
Note, that you still have to specify dates in the ''Start date'' and ''End date'' field, because they actually tell the program how to draw the time interval on the Timeline.
 


''Comment'' - this field is only used for time intervals. If you put some text in it (for example: <code><nowiki>some time interval;;;this is a comment with a [[Hannibal|link]];1978;1982;</nowiki></code>), the plus button will appear on the time interval:
''Comment'' - this field is only used for time intervals. If you put some text in it (for example: <code><nowiki>some time interval;;;this is a comment with a [[Hannibal|link]];1978;1982;</nowiki></code>), the plus button will appear on the time interval:
Line 176: Line 195:


Note that you can combine color index with transparency marker.
Note that you can combine color index with transparency marker.
===Calendars===
Let’s talk a bit about calendars used by the Timeline. As you know the calendar reform that replaced Julian calendar with Gregorian calendar took place in 1582. If you look at October 1582 on the Timeline, you’ll see that October 4th is followed by October 15th.
[[File:October1582.png]]
October 4, 1582 is the last Julian date, and October 15, 1582 is the first Gregorian date. As far as I know, any dates before the calendar reform that you can find in pretty much any historical literature are Julian dates. So, when it comes to the Timeline, it makes sense to use Julian calendar for dates up until the reform and Gregorian calendar for all the dates after the reform. That’s why when you enter dates earlier or equal to October 4, 1582, the program assumes that those are Julian dates. Dates from October 15, 1528 and onward are assumed to be Gregorian.
Put these instructions into the Editor:
<blockquote><poem>
Last day of Julian calendar;;;;10.04.1582;;
First day of Gregorian calendar;;;;10.15.1582;;
</poem></blockquote>
And you’ll get this:
[[File:CalendarReform.png]]
If you open the Menu and select to show Julian dates, you’ll see that in Julian calendar those dates are just 4th and 5th of October.
[[File:October1582Julian.png]]
If you use the sources with Old style dates (i.e. Julian dates after the calendar reform) you need to convert them into Gregorian dates. It is easy to do with the [[Documentation:How to use the Parser|Parser]].
A few facts about Julian calendar:
*People started using February 29th as a leap day only in the late Middle Ages. Before that they inserted an extra day after February 23rd. The Timeline doesn’t reflect that. We always use February 29th as a leap day on the Timeline.
*The leap years that were actually observed between the implementation of the Julian calendar in 45 BC and AD 8 were erratic, so we use a proleptic Julian calendar for anything before AD 8. Basically we just make every 4th year a leap year regardless of what happened in reality. In the Common era leap years are 4 AD, 8 AD, 12 AD and so on. Leap years before Common era are: 1 BC, 5 BC, 9 BC and so on.
*Year 46 BC (the year of Caesar’s calendar reform) had 445 days in it. A bunch of preceding years were much shorter than usual year. The Timeline ignores all that. We just use normal 356 and 366 day years for all the years BC. This can be changed with future updates if such need ever arises.


===Layer metadata===
===Layer metadata===
Line 289: Line 277:
''Visible text'' - is usually the name of the page containing layer data.  
''Visible text'' - is usually the name of the page containing layer data.  


''Link'' - if the actual name of the text differs from the visible text, specify full name of the article here.
''Link'' - if the actual name of the page differs from the visible text, specify the name of the page here.


''Is list'' - This field is used for layers presented as a list of time intervals that you can toggle individually.  
''Is list'' - This field is used for layers presented as a list of time intervals that you can toggle individually.  
Retrieved from "http://timeline.oldera.org/wiki/index.php/Special:MobileDiff/57...81"

Navigation menu