From 7d6f30075435759434c73e4d210bb7d544259b28 Mon Sep 17 00:00:00 2001 From: MineRobber___T Date: Sun, 10 Apr 2016 06:26:30 -0400 Subject: [PATCH 1/4] Create To Do List.md --- File Formats/Documents/To Do List.md | 32 ++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 File Formats/Documents/To Do List.md diff --git a/File Formats/Documents/To Do List.md b/File Formats/Documents/To Do List.md new file mode 100644 index 0000000..33f79f0 --- /dev/null +++ b/File Formats/Documents/To Do List.md @@ -0,0 +1,32 @@ +# _To Do List_ +| Information | | +|-------------|---------------------------------------------------------------------------------------| +| Version | 0.1.0 | +| Type | Document file format | +| MIME | `basic/tdl` | +| Extensions | `.tdl` | + +### Technical Details +This format is an attempt to create one united standard for to-do lists. + +A TDL file has some requirements: +* It must be a serialized table. +* Each item in that table must be a table containing a string and a boolean. + +Regarding the last bullet, the string is the name of the task, and the boolean is whether it is finished or not. +#### Available Utilities +* TDLClient - For manipulating TDL files. +* TDLViewer - For viewing the contents of a TDL file. + +### Examples +#### Installation +Use `pastebin run Hpum9P5F` and choose "y" when prompted. This will install TDLClient and TDLViewer. + +#### Usage +```Lua +-- example of TDL file +{ + {"Show off how minimalistic this looks.",true,}, + {"Find out the Doctor's name.",false,} +} +``` From b4679b5e126414ac334d49a4b622cf6e8115511c Mon Sep 17 00:00:00 2001 From: MineRobber___T Date: Mon, 18 Apr 2016 17:07:13 -0400 Subject: [PATCH 2/4] Update To Do List.md provided for varying levels of completion, now on to subtasks! oh boy... --- File Formats/Documents/To Do List.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/File Formats/Documents/To Do List.md b/File Formats/Documents/To Do List.md index 33f79f0..0ef607e 100644 --- a/File Formats/Documents/To Do List.md +++ b/File Formats/Documents/To Do List.md @@ -1,19 +1,19 @@ # _To Do List_ | Information | | |-------------|---------------------------------------------------------------------------------------| -| Version | 0.1.0 | +| Version | 0.2.0 | | Type | Document file format | | MIME | `basic/tdl` | | Extensions | `.tdl` | ### Technical Details -This format is an attempt to create one united standard for to-do lists. A TDL file has some requirements: * It must be a serialized table. -* Each item in that table must be a table containing a string and a boolean. +* Each item in that table must be a table containing a string (to be used as the name of the task) and a number between 0 and 1 (the percent of completion, divided by 100). + +Even though the standard states that the number must be between 0 and 1, programs should add a case for if the table is malformed. -Regarding the last bullet, the string is the name of the task, and the boolean is whether it is finished or not. #### Available Utilities * TDLClient - For manipulating TDL files. * TDLViewer - For viewing the contents of a TDL file. @@ -24,9 +24,8 @@ Use `pastebin run Hpum9P5F` and choose "y" when prompted. This will install TDLC #### Usage ```Lua --- example of TDL file { - {"Show off how minimalistic this looks.",true,}, - {"Find out the Doctor's name.",false,} + {"Show off how minimalistic this looks.",1,}, + {"Find out the Doctor's name.",0,} } ``` From fc164deaf9dd27000923131d035a76dc323e15b7 Mon Sep 17 00:00:00 2001 From: MineRobber___T Date: Thu, 27 Oct 2016 17:42:58 -0400 Subject: [PATCH 3/4] Fix MIME Type and Rename Specification see my comment --- File Formats/Documents/To Do List.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/File Formats/Documents/To Do List.md b/File Formats/Documents/To Do List.md index 0ef607e..bd07d33 100644 --- a/File Formats/Documents/To Do List.md +++ b/File Formats/Documents/To Do List.md @@ -1,9 +1,9 @@ -# _To Do List_ +# _Basic To Do List_ | Information | | |-------------|---------------------------------------------------------------------------------------| | Version | 0.2.0 | | Type | Document file format | -| MIME | `basic/tdl` | +| MIME | `text/tdl` | | Extensions | `.tdl` | ### Technical Details From 73ccec506c3a61debee8afa0798332ecd6e5e5b7 Mon Sep 17 00:00:00 2001 From: MineRobber___T Date: Mon, 31 Oct 2016 16:25:08 -0400 Subject: [PATCH 4/4] Update To Do List.md --- File Formats/Documents/To Do List.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/File Formats/Documents/To Do List.md b/File Formats/Documents/To Do List.md index bd07d33..a9b0d09 100644 --- a/File Formats/Documents/To Do List.md +++ b/File Formats/Documents/To Do List.md @@ -1,7 +1,7 @@ -# _Basic To Do List_ +# _To Do List_ | Information | | |-------------|---------------------------------------------------------------------------------------| -| Version | 0.2.0 | +| Version | 0.3.0 | | Type | Document file format | | MIME | `text/tdl` | | Extensions | `.tdl` | @@ -10,22 +10,27 @@ A TDL file has some requirements: * It must be a serialized table. -* Each item in that table must be a table containing a string (to be used as the name of the task) and a number between 0 and 1 (the percent of completion, divided by 100). +* Each item in that table must be a table containing a string (to be used as the name of the task) and a number between 0 and 1 (the percent of completion, divided by 100) OR a table where each item in that table must be a table containing a string (to be used as the name of the task) and a number between 0 and 1 (the percent of completion, divided by 100). -Even though the standard states that the number must be between 0 and 1, programs should add a case for if the table is malformed. +Programs should check to make sure the table meets the standard while or before using the contents of said table. #### Available Utilities -* TDLClient - For manipulating TDL files. +* TDLClient (discontinued) - For manipulating TDL files. * TDLViewer - For viewing the contents of a TDL file. ### Examples #### Installation -Use `pastebin run Hpum9P5F` and choose "y" when prompted. This will install TDLClient and TDLViewer. +Use `pastebin run Hpum9P5F` and choose "y" when prompted. This will install TDLViewer. If you wish, you can then enter "y" again to install the outdated TDLCLient. TDLClient will not render tasks with subtasks. #### Usage ```Lua { {"Show off how minimalistic this looks.",1,}, - {"Find out the Doctor's name.",0,} + {"Find out the Doctor's name.", + {"Track down the Doctor", 1,}, + {"Ask the Doctor what their name is", 0,}, + }, } ``` + +(example courtesy of Lyqyd)