From 7e2602f9f93d235e3577c81987e3c644f68ba896 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 8 Jan 2016 18:28:31 +0100 Subject: [PATCH 1/5] Add basic file structure --- doc/src/0100-intro.md | 2 ++ doc/src/0200-store.md | 6 ++++ doc/src/0300-lib-core.md | 11 ++++++ doc/src/0400-lib-store.md | 6 ++++ doc/src/0500-lib-module | 4 +++ doc/src/0600-modules.md | 54 ++++++++++++++++++++++++++++ doc/src/0700-commands.md | 76 +++++++++++++++++++++++++++++++++++++++ 7 files changed, 159 insertions(+) create mode 100644 doc/src/0100-intro.md create mode 100644 doc/src/0200-store.md create mode 100644 doc/src/0300-lib-core.md create mode 100644 doc/src/0400-lib-store.md create mode 100644 doc/src/0500-lib-module create mode 100644 doc/src/0600-modules.md create mode 100644 doc/src/0700-commands.md diff --git a/doc/src/0100-intro.md b/doc/src/0100-intro.md new file mode 100644 index 00000000..e036e5a4 --- /dev/null +++ b/doc/src/0100-intro.md @@ -0,0 +1,2 @@ +# Introduction {#sec:introduction} + diff --git a/doc/src/0200-store.md b/doc/src/0200-store.md new file mode 100644 index 00000000..0fa70db0 --- /dev/null +++ b/doc/src/0200-store.md @@ -0,0 +1,6 @@ +# The Store {#sec:thestore} + +## File Format {#sec:thestore:fileformat} + +## File organization {#sec:thestore:fileorganization} + diff --git a/doc/src/0300-lib-core.md b/doc/src/0300-lib-core.md new file mode 100644 index 00000000..a79bb68c --- /dev/null +++ b/doc/src/0300-lib-core.md @@ -0,0 +1,11 @@ +# libcore {#sec:libcore} + + + +## Core Datatypes {#sec:libcore:coredatatypes} + +## Core functions {#sec:libcore:corefunctions} + diff --git a/doc/src/0400-lib-store.md b/doc/src/0400-lib-store.md new file mode 100644 index 00000000..628fafe0 --- /dev/null +++ b/doc/src/0400-lib-store.md @@ -0,0 +1,6 @@ +# libstore {#sec:libstore} + + + diff --git a/doc/src/0500-lib-module b/doc/src/0500-lib-module new file mode 100644 index 00000000..1eb4a133 --- /dev/null +++ b/doc/src/0500-lib-module @@ -0,0 +1,4 @@ +# libmodule {#sec:libmodule} + + + diff --git a/doc/src/0600-modules.md b/doc/src/0600-modules.md new file mode 100644 index 00000000..3f8bb7e0 --- /dev/null +++ b/doc/src/0600-modules.md @@ -0,0 +1,54 @@ +# Modules {#sec:modules} + +## Bibliography {#sec:modules:bibliography} + +The Bibliography module. + +## Bookmarks {#sec:modules:bookmarks} + +The Bookmarks module. + +## Calendar {#sec:modules:calendar} + +The Calendar module. + +## Contacts {#sec:modules:contacts} + +The Contacts module. + +## Images {#sec:modules:images} + +The Images module. + +## Mails {#sec:modules:mails} + +The Mails module. + +## Movies {#sec:modules:movies} + +The Movies module. + +## Music {#sec:modules:music} + +The Music module. + +## News {#sec:modules:news} + +The News module. + +## Notes {#sec:modules:notes} + +The Notes module. + +## Shoppinglists {#sec:modules:shoppinglists} + +The Shoppinglists module. + +## Todos {#sec:modules:todos} + +The Todos module. + +## Wiki {#sec:modules:wiki} + +The Wiki module. + diff --git a/doc/src/0700-commands.md b/doc/src/0700-commands.md new file mode 100644 index 00000000..ee45df3e --- /dev/null +++ b/doc/src/0700-commands.md @@ -0,0 +1,76 @@ +# Commands {#sec:commands} + + + + +## Command: store + +The store command, built onto @sec:libstore. + + +## Command: Bibliography {#sec:command:bibliography} + +The command build onto the Bibliography-Module (@sec:modules:bibliography). + + +## Command: Bookmarks {#sec:command:bookmarks} + +The command build onto the Bookmarks-Module (@sec:modules:bookmarks). + + +## Command: Calendar {#sec:command:calendar} + +The command build onto the Calendar-Module (@sec:modules:calendar). + + +## Command: Contacts {#sec:command:contacts} + +The command build onto the Contacts-Module (@sec:modules:contacts). + + +## Command: Images {#sec:command:images} + +The command build onto the Images-Module (@sec:modules:images). + + +## Command: Mails {#sec:command:mails} + +The command build onto the Mails-Module (@sec:modules:mails). + + +## Command: Movies {#sec:command:movies} + +The command build onto the Movies-Module (@sec:modules:movies). + + +## Command: Music {#sec:command:music} + +The command build onto the Music-Module (@sec:modules:music). + + +## Command: News {#sec:command:news} + +The command build onto the News-Module (@sec:modules:news). + + +## Command: Notes {#sec:command:notes} + +The command build onto the Notes-Module (@sec:modules:notes). + + +## Command: Shoppinglists {#sec:command:shoppinglists} + +The command build onto the Shoppinglists-Module (@sec:modules:shoppinglists). + + +## Command: Todos {#sec:command:todos} + +The command build onto the Todos-Module (@sec:modules:todos). + + +## Command: Wiki {#sec:command:wiki} + +The command build onto the Wiki-Module (@sec:modules:wiki). + From f25c4665c191b714f3908e1c7c5c638942117629 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 8 Jan 2016 21:08:42 +0100 Subject: [PATCH 2/5] Fix filename --- doc/src/{0500-lib-module => 0500-lib-module.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/src/{0500-lib-module => 0500-lib-module.md} (100%) diff --git a/doc/src/0500-lib-module b/doc/src/0500-lib-module.md similarity index 100% rename from doc/src/0500-lib-module rename to doc/src/0500-lib-module.md From a2c93f9fe90c9e28f0d02dda5c83904751acdc52 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 8 Jan 2016 21:12:13 +0100 Subject: [PATCH 3/5] Comment out some modules/commands These are not that relevant for the first iteration. Keep quite a lot others, as we need to consider different use-cases for the store to be able to define a module-independent store format and so on. --- doc/src/0600-modules.md | 8 ++++++++ doc/src/0700-commands.md | 10 ++++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/doc/src/0600-modules.md b/doc/src/0600-modules.md index 3f8bb7e0..22afef0a 100644 --- a/doc/src/0600-modules.md +++ b/doc/src/0600-modules.md @@ -1,8 +1,10 @@ # Modules {#sec:modules} + ## Bookmarks {#sec:modules:bookmarks} @@ -16,14 +18,17 @@ The Calendar module. The Contacts module. + ## Mails {#sec:modules:mails} The Mails module. + ## Notes {#sec:modules:notes} The Notes module. + ## Todos {#sec:modules:todos} diff --git a/doc/src/0700-commands.md b/doc/src/0700-commands.md index ee45df3e..48e93e13 100644 --- a/doc/src/0700-commands.md +++ b/doc/src/0700-commands.md @@ -10,10 +10,11 @@ The store command, built onto @sec:libstore. + ## Command: Bookmarks {#sec:command:bookmarks} @@ -29,10 +30,11 @@ The command build onto the Calendar-Module (@sec:modules:calendar). The command build onto the Contacts-Module (@sec:modules:contacts). - + ## Command: Mails {#sec:command:mails} @@ -40,6 +42,7 @@ The command build onto the Images-Module (@sec:modules:images). The command build onto the Mails-Module (@sec:modules:mails). + ## Command: Notes {#sec:command:notes} @@ -60,9 +64,11 @@ The command build onto the News-Module (@sec:modules:news). The command build onto the Notes-Module (@sec:modules:notes). + ## Command: Todos {#sec:command:todos} From 86ad93a5e95452c361edfdde9f901d0945694f37 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 9 Jan 2016 21:12:00 +0100 Subject: [PATCH 4/5] Rewrite structure --- doc/src/{0000.md => 00000.md} | 0 doc/src/{0100-intro.md => 01000-intro.md} | 0 doc/src/{0200-store.md => 02000-store.md} | 0 .../{0300-lib-core.md => 03000-lib-core.md} | 0 .../{0400-lib-store.md => 04000-lib-store.md} | 0 ...0500-lib-module.md => 05000-lib-module.md} | 0 doc/src/0600-modules.md | 62 ------------------- doc/src/06000-modules.md | 2 + doc/src/06010-module-bibliography.md | 6 ++ doc/src/06020-module-bookmarks.md | 4 ++ doc/src/06030-module-calendar.md | 5 ++ doc/src/06040-module-contacts.md | 5 ++ doc/src/06050-module-images.md | 6 ++ doc/src/06060-module-mails.md | 4 ++ doc/src/06070-module-movies | 7 +++ doc/src/06080-module-music.md | 6 ++ doc/src/06090-module-news.md | 6 ++ doc/src/06100-module-notes.md | 4 ++ doc/src/06110-module-shoppinglists.md | 6 ++ doc/src/06120-module-todo.md | 4 ++ doc/src/06130-module-wiki.md | 4 ++ .../{0700-commands.md => 07000-commands.md} | 0 22 files changed, 69 insertions(+), 62 deletions(-) rename doc/src/{0000.md => 00000.md} (100%) rename doc/src/{0100-intro.md => 01000-intro.md} (100%) rename doc/src/{0200-store.md => 02000-store.md} (100%) rename doc/src/{0300-lib-core.md => 03000-lib-core.md} (100%) rename doc/src/{0400-lib-store.md => 04000-lib-store.md} (100%) rename doc/src/{0500-lib-module.md => 05000-lib-module.md} (100%) delete mode 100644 doc/src/0600-modules.md create mode 100644 doc/src/06000-modules.md create mode 100644 doc/src/06010-module-bibliography.md create mode 100644 doc/src/06020-module-bookmarks.md create mode 100644 doc/src/06030-module-calendar.md create mode 100644 doc/src/06040-module-contacts.md create mode 100644 doc/src/06050-module-images.md create mode 100644 doc/src/06060-module-mails.md create mode 100644 doc/src/06070-module-movies create mode 100644 doc/src/06080-module-music.md create mode 100644 doc/src/06090-module-news.md create mode 100644 doc/src/06100-module-notes.md create mode 100644 doc/src/06110-module-shoppinglists.md create mode 100644 doc/src/06120-module-todo.md create mode 100644 doc/src/06130-module-wiki.md rename doc/src/{0700-commands.md => 07000-commands.md} (100%) diff --git a/doc/src/0000.md b/doc/src/00000.md similarity index 100% rename from doc/src/0000.md rename to doc/src/00000.md diff --git a/doc/src/0100-intro.md b/doc/src/01000-intro.md similarity index 100% rename from doc/src/0100-intro.md rename to doc/src/01000-intro.md diff --git a/doc/src/0200-store.md b/doc/src/02000-store.md similarity index 100% rename from doc/src/0200-store.md rename to doc/src/02000-store.md diff --git a/doc/src/0300-lib-core.md b/doc/src/03000-lib-core.md similarity index 100% rename from doc/src/0300-lib-core.md rename to doc/src/03000-lib-core.md diff --git a/doc/src/0400-lib-store.md b/doc/src/04000-lib-store.md similarity index 100% rename from doc/src/0400-lib-store.md rename to doc/src/04000-lib-store.md diff --git a/doc/src/0500-lib-module.md b/doc/src/05000-lib-module.md similarity index 100% rename from doc/src/0500-lib-module.md rename to doc/src/05000-lib-module.md diff --git a/doc/src/0600-modules.md b/doc/src/0600-modules.md deleted file mode 100644 index 22afef0a..00000000 --- a/doc/src/0600-modules.md +++ /dev/null @@ -1,62 +0,0 @@ -# Modules {#sec:modules} - - - -## Bookmarks {#sec:modules:bookmarks} - -The Bookmarks module. - -## Calendar {#sec:modules:calendar} - -The Calendar module. - -## Contacts {#sec:modules:contacts} - -The Contacts module. - - - -## Mails {#sec:modules:mails} - -The Mails module. - - - -## Notes {#sec:modules:notes} - -The Notes module. - - - -## Todos {#sec:modules:todos} - -The Todos module. - -## Wiki {#sec:modules:wiki} - -The Wiki module. - diff --git a/doc/src/06000-modules.md b/doc/src/06000-modules.md new file mode 100644 index 00000000..3e7a06ce --- /dev/null +++ b/doc/src/06000-modules.md @@ -0,0 +1,2 @@ +# Modules {#sec:modules} + diff --git a/doc/src/06010-module-bibliography.md b/doc/src/06010-module-bibliography.md new file mode 100644 index 00000000..de84b5f4 --- /dev/null +++ b/doc/src/06010-module-bibliography.md @@ -0,0 +1,6 @@ + + diff --git a/doc/src/06020-module-bookmarks.md b/doc/src/06020-module-bookmarks.md new file mode 100644 index 00000000..d98285a3 --- /dev/null +++ b/doc/src/06020-module-bookmarks.md @@ -0,0 +1,4 @@ +## Bookmarks {#sec:modules:bookmarks} + +The Bookmarks module. + diff --git a/doc/src/06030-module-calendar.md b/doc/src/06030-module-calendar.md new file mode 100644 index 00000000..08de6e86 --- /dev/null +++ b/doc/src/06030-module-calendar.md @@ -0,0 +1,5 @@ +## Calendar {#sec:modules:calendar} + +The Calendar module. + + diff --git a/doc/src/06040-module-contacts.md b/doc/src/06040-module-contacts.md new file mode 100644 index 00000000..01047e32 --- /dev/null +++ b/doc/src/06040-module-contacts.md @@ -0,0 +1,5 @@ +## Contacts {#sec:modules:contacts} + +The Contacts module. + + diff --git a/doc/src/06050-module-images.md b/doc/src/06050-module-images.md new file mode 100644 index 00000000..7c78b5d9 --- /dev/null +++ b/doc/src/06050-module-images.md @@ -0,0 +1,6 @@ + + diff --git a/doc/src/06060-module-mails.md b/doc/src/06060-module-mails.md new file mode 100644 index 00000000..eb6e37a0 --- /dev/null +++ b/doc/src/06060-module-mails.md @@ -0,0 +1,4 @@ +## Mails {#sec:modules:mails} + +The Mails module. + diff --git a/doc/src/06070-module-movies b/doc/src/06070-module-movies new file mode 100644 index 00000000..3849f1b1 --- /dev/null +++ b/doc/src/06070-module-movies @@ -0,0 +1,7 @@ + + + diff --git a/doc/src/06080-module-music.md b/doc/src/06080-module-music.md new file mode 100644 index 00000000..d57a64a6 --- /dev/null +++ b/doc/src/06080-module-music.md @@ -0,0 +1,6 @@ + + diff --git a/doc/src/06090-module-news.md b/doc/src/06090-module-news.md new file mode 100644 index 00000000..3d537f72 --- /dev/null +++ b/doc/src/06090-module-news.md @@ -0,0 +1,6 @@ + + diff --git a/doc/src/06100-module-notes.md b/doc/src/06100-module-notes.md new file mode 100644 index 00000000..432b2df6 --- /dev/null +++ b/doc/src/06100-module-notes.md @@ -0,0 +1,4 @@ +## Notes {#sec:modules:notes} + +The Notes module. + diff --git a/doc/src/06110-module-shoppinglists.md b/doc/src/06110-module-shoppinglists.md new file mode 100644 index 00000000..20c1dcb5 --- /dev/null +++ b/doc/src/06110-module-shoppinglists.md @@ -0,0 +1,6 @@ + + diff --git a/doc/src/06120-module-todo.md b/doc/src/06120-module-todo.md new file mode 100644 index 00000000..1c3f5393 --- /dev/null +++ b/doc/src/06120-module-todo.md @@ -0,0 +1,4 @@ +## Todos {#sec:modules:todos} + +The Todos module. + diff --git a/doc/src/06130-module-wiki.md b/doc/src/06130-module-wiki.md new file mode 100644 index 00000000..5b273fb7 --- /dev/null +++ b/doc/src/06130-module-wiki.md @@ -0,0 +1,4 @@ +## Wiki {#sec:modules:wiki} + +The Wiki module. + diff --git a/doc/src/0700-commands.md b/doc/src/07000-commands.md similarity index 100% rename from doc/src/0700-commands.md rename to doc/src/07000-commands.md From fdc63e01945bbfeca462ade1abddcf68d875d5b3 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Sat, 9 Jan 2016 21:12:53 +0100 Subject: [PATCH 5/5] Remove chapter on commands, should be included in chapter on modules --- doc/src/07000-commands.md | 82 --------------------------------------- 1 file changed, 82 deletions(-) delete mode 100644 doc/src/07000-commands.md diff --git a/doc/src/07000-commands.md b/doc/src/07000-commands.md deleted file mode 100644 index 48e93e13..00000000 --- a/doc/src/07000-commands.md +++ /dev/null @@ -1,82 +0,0 @@ -# Commands {#sec:commands} - - - - -## Command: store - -The store command, built onto @sec:libstore. - - - - -## Command: Bookmarks {#sec:command:bookmarks} - -The command build onto the Bookmarks-Module (@sec:modules:bookmarks). - - -## Command: Calendar {#sec:command:calendar} - -The command build onto the Calendar-Module (@sec:modules:calendar). - - -## Command: Contacts {#sec:command:contacts} - -The command build onto the Contacts-Module (@sec:modules:contacts). - - - - -## Command: Mails {#sec:command:mails} - -The command build onto the Mails-Module (@sec:modules:mails). - - - - - -## Command: Notes {#sec:command:notes} - -The command build onto the Notes-Module (@sec:modules:notes). - - - - - -## Command: Todos {#sec:command:todos} - -The command build onto the Todos-Module (@sec:modules:todos). - - -## Command: Wiki {#sec:command:wiki} - -The command build onto the Wiki-Module (@sec:modules:wiki). -