0033d1b4b4
Add documentation file
2017-06-21 18:29:49 +02:00
266311d743
Change backends to do less ser-/deserialization
...
This commit changes the backends to do less de/ser, as it now stores the
Entry objects in the backend and does the de/serialization there.
This means the store does only serialize things once from json to toml
in the io backend.
See the diff of the documentation for more details.
2017-06-18 12:32:04 +02:00
c4b2287876
Move the documentation to the docs
2017-06-18 11:33:18 +02:00
9254851724
doc: Remove hook stuff
2017-06-06 11:12:37 +02:00
9650f46e23
Version strings: 0.2.0 -> 0.3.0
2017-05-03 10:48:26 +02:00
ccad830953
Add more long-term todos
2017-02-20 15:13:47 +01:00
d75bc2d928
Add TODOs about libimag{rt,store{,stdhook}} merge
2017-02-20 14:51:06 +01:00
eaf34ac6e9
Add long-term todos in libimagref
2017-02-20 14:51:06 +01:00
3a18655a7f
Increment header levels in the README.md I missed in the first run
2016-10-13 12:07:54 +02:00
e30d774670
Move all libimag*/README.md to doc/src/05100-*
2016-10-13 12:04:36 +02:00
a2e2fc93b1
Add library documentation subchapter
2016-10-13 12:04:36 +02:00
da439e60e9
Add documentation what a valid tag is
2016-09-30 10:45:28 +02:00
69a10b2d02
Merge pull request #601 from matthiasbeyer/doc-updates
...
Doc updates
2016-08-02 13:01:40 +02:00
75f57d622c
doc: Fix code listing
2016-07-30 21:36:45 +02:00
34e164e954
doc: Add more description of modules
2016-07-30 21:32:50 +02:00
40d4939f3a
doc: Fix up store entry example markup and content
2016-07-30 21:02:21 +02:00
3e4d01a339
Add missing dependency: which
2016-07-30 20:59:49 +02:00
bbb5e58583
doc: Fix filename
2016-07-30 20:58:04 +02:00
6f71dc517f
doc: Remove comment
2016-07-30 20:57:36 +02:00
9354ae003a
doc: Fix bullet-list markup
2016-07-30 20:56:57 +02:00
4e230ecc61
doc: Update version
2016-07-30 20:55:18 +02:00
008f4d0032
Add new non-optional dependencies to doc in default.nix
2016-07-30 20:53:12 +02:00
0c5674dd47
Merge pull request #525 from matthiasbeyer/update-doc
...
Update doc
2016-07-14 21:11:30 +02:00
e250059390
doc: Add file for tagging module documentation
2016-07-13 18:34:58 +02:00
f36851786a
doc: Add description for linking module
2016-07-13 18:34:00 +02:00
f8b1d48307
doc: Add user documentation for imag-diary
2016-07-13 18:27:36 +02:00
45d41748f6
doc: Add store module documentation
2016-07-12 17:12:16 +02:00
51432eaf39
Add example how to use imag-counter
2016-07-12 17:00:02 +02:00
9337a14cdd
Update all version strings: 0.1.0 -> 0.2.0
2016-07-12 11:51:20 +02:00
1bf7d16664
doc: template: Add TOC
2016-07-08 21:11:28 +02:00
6f958d2a68
doc: template: title page plain
2016-07-08 21:11:28 +02:00
fd1fd6881a
doc: template: Make the title page the title page only
2016-07-08 21:05:03 +02:00
ed4b198359
doc: Fix version string
2016-07-08 20:58:47 +02:00
9283d964d5
doc: Add most basic section structure for module files
2016-07-08 20:51:45 +02:00
a8206b8f19
doc: Remove comment markers
2016-07-08 20:48:41 +02:00
fafc8418df
doc: Remove utility documentation, as the user should never see this
2016-07-08 20:43:32 +02:00
39c1b30e6f
doc: Add module file for view
2016-07-08 20:43:32 +02:00
0b1356a104
doc: Rewrite initial text for module section
2016-07-08 20:43:25 +02:00
1c0fc5a0a7
doc: Remove file on tagging
2016-07-08 20:43:25 +02:00
5a229a24b0
doc: Add module files: {link, ref}
2016-07-08 20:43:25 +02:00
f81e47ceb2
doc: Rewrite linking chapter
2016-07-08 20:43:20 +02:00
7a8432123b
doc: Rewrite "The Store" chapter
2016-07-08 20:43:12 +02:00
28a9c5ffc9
doc: Rewrote intro
2016-07-08 20:43:06 +02:00
12cb61cd8b
doc: Rename documentation files for modules
2016-07-08 17:42:47 +02:00
d8c4d55312
doc: Add chapter on technical details
2016-07-08 17:39:19 +02:00
d0a5beae9a
doc: Remove library documentation files
2016-07-08 17:37:58 +02:00
b0de23bfbf
doc: Rename document, set new date
2016-07-08 17:37:47 +02:00
Gavin Thomas Claugus
2760e30d6c
Define tasks for manpage generation
...
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:27:11 -04:00
Gavin Thomas Claugus
9c6a9b5eed
Define TARGET_MAN variable with manpage target dir
...
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:13:48 -04:00
Gavin Thomas Claugus
7bc2c094a1
Export PANDOC_CC_MAN command
...
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:12:51 -04:00
Gavin Thomas Claugus
c0042196da
Add DOCUMENT_SETTINGS_MAN variable
...
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:09:20 -04:00
Gavin Thomas Claugus
0185ab3fd8
Export manpage output directory
...
Signed-off-by: Gavin Thomas Claugus <gclaugus@gmail.com>
2016-07-03 13:06:18 -04:00
9fa362c22c
Add initial proposal for notes module
2016-03-25 16:30:12 +01:00
f253931bb7
doc: Adjust documentation to match implementation
2016-03-16 16:46:54 +01:00
4dc1140149
doc: Add hook aspect definition
2016-03-16 16:46:52 +01:00
c9bca51273
doc: Add documentation for the Hook system
2016-03-16 16:46:51 +01:00
8d234440b5
doc: imag-counter
2016-03-15 15:01:10 +01:00
20201d2358
Merge pull request #210 from matthiasbeyer/doc/libimagutil
...
Doc/libimagutil
2016-03-07 17:18:50 +01:00
637faf2d66
Merge pull request #219 from matthiasbeyer/doc/add-module-files
...
Add module files for several modules
2016-03-07 17:14:30 +01:00
a02a0f2fde
Merge pull request #167 from matthiasbeyer/doc/linking
...
doc: Add chapter on linking
2016-03-06 11:53:18 +01:00
fc46f1a8df
doc: imag:// prefix should be optional
2016-03-06 11:18:31 +01:00
5b034dc37b
doc: Add liblink specification
2016-03-06 11:18:01 +01:00
4b4809571a
doc: Add paragraph in section for linking internal content
2016-03-06 11:17:30 +01:00
fc7a86ba50
doc: Add initial paragraph
2016-03-06 11:17:30 +01:00
a51b68e838
doc: Add chapter on linking
2016-03-06 11:17:26 +01:00
7ff1995acc
Move files to new filenames, so we have alphabetical ordering
2016-03-02 17:32:24 +01:00
3c30cecee8
Add module files for several modules
...
Rename modules, so we have alphabetical order for the modules, which is
way nicer than the current order.
The following modules are added:
- borrow
- counter
- cuecards
- dairy
- ledger
- password
- weather
Plus, this commit adds an utility module file, where the utility modules
are described
2016-02-29 20:21:51 +01:00
22b41004ae
doc: Remove file for "libimagmodule", as this was removed
2016-02-21 20:33:36 +01:00
babb7b7055
doc: libimagutil: Add documentation of the generate_variants() util
2016-02-21 20:27:24 +01:00
6baa3c7f38
doc: libimagutil: Add error-tracing utility documentation
2016-02-21 20:27:23 +01:00
3e18a6df6c
doc: libimagutil: Add kv-split documentation
2016-02-21 20:26:56 +01:00
c25f32fd85
Add chapter on libtag
2016-02-05 11:55:49 +01:00
b4d88c72bf
doc: Add section store/tagging
2016-02-05 11:55:48 +01:00
Marcel Müller
dbbda9bf5d
Explain futureproofing store files
2016-01-23 19:01:29 +01:00
Homu
2c1fa1a92a
Auto merge of #89 - matthiasbeyer:libimagrt-init, r=matthiasbeyer
...
Libimagrt init
Initial code for `libimagrt`.
2016-01-21 07:59:38 -08:00
e44e413b08
Clear the "imag.content" key definition.
2016-01-19 17:34:52 +01:00
6183efedbc
Fix: Remove "mime"-key in header
...
We don't need this one, actually.
2016-01-19 17:34:52 +01:00
9d9efa76ea
Update example
2016-01-19 17:34:52 +01:00
adaa6b69ec
Clearify content section format (as seen by the store library)
2016-01-19 17:34:52 +01:00
cafc6dbadf
Rewrite chapter on header contents
2016-01-19 17:34:52 +01:00
88930da796
Add fields in the header section "imag"
2016-01-19 16:51:41 +01:00
4ce693c05f
Add paragraph on store path links
2016-01-19 16:49:14 +01:00
78d25ebad7
Rewrite part on store path format
2016-01-19 16:49:14 +01:00
71dc86d2e7
doc: Add more paths where we search for config
2016-01-18 19:22:14 +01:00
Homu
469bdd1d94
Auto merge of #99 - TheNeikos:add-libstore, r=matthiasbeyer
...
Add libimagstore
Alright, do check the file and feel free to post comments/ask questions
2016-01-17 23:44:27 +09:00
Marcel Müller
2f99f5561a
Remove Store caching from docs
2016-01-17 15:37:07 +01:00
Marcel Müller
b06621c6bd
Add doc for mutators entry has to export
2016-01-17 15:37:02 +01:00
Marcel Müller
49184c10a3
Add FileLockEntry to doc table
2016-01-17 15:36:41 +01:00
4857456d0f
doc: Add introduction
2016-01-14 17:00:49 +01:00
9d265159ee
doc: Add initial version of lib-store documentation/definition
2016-01-12 19:21:41 +01:00
Homu
ec6ac7794f
Auto merge of #90 - matthiasbeyer:doc-define-store-format, r=matthiasbeyer
...
Define file format
Related to #76 .
@TheNeikos , @neithernut Would like to hear suggestions.
2016-01-13 01:52:52 +09:00
535c2f4d4c
Modules store data not in a subsection of the "imag" section
2016-01-12 17:09:04 +01:00
ddb3a2717a
doc: store: fileformat: Add example
2016-01-12 13:07:49 +01:00
Homu
3f446f1fd8
Auto merge of #92 - matthiasbeyer:doc-define-modules, r=matthiasbeyer
...
Doc define modules
Includes definition of runtime library.
2016-01-12 02:49:30 +09:00
6141c8499d
doc: Add definition of modules
2016-01-11 18:15:22 +01:00
c8f0b26577
doc: rt: Add chapter on configuration file
2016-01-11 18:15:22 +01:00
4cd01bbec7
Add table css for html template
2016-01-11 18:04:29 +01:00
4eabdc19aa
Add css-include setup for html template
2016-01-11 18:04:29 +01:00
d636339abe
doc: define runtime library
2016-01-11 17:22:36 +01:00
e92cd8d558
State that modules can store data in the "imag" part of the header
2016-01-11 09:29:13 +01:00
a377a9a031
Add file organization spec
2016-01-10 18:07:15 +01:00
363d611522
Define file format
2016-01-10 18:07:15 +01:00
7c1e1fb8d5
Add initial content for libutil
2016-01-10 17:46:40 +01:00
906c4cbd00
There is no libcore, there is only libutil
2016-01-10 17:44:17 +01:00
fdc63e0194
Remove chapter on commands, should be included in chapter on modules
2016-01-09 21:12:53 +01:00
86ad93a5e9
Rewrite structure
2016-01-09 21:12:00 +01:00
a2c93f9fe9
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.
2016-01-08 21:12:13 +01:00
f25c4665c1
Fix filename
2016-01-08 21:08:42 +01:00
7e2602f9f9
Add basic file structure
2016-01-08 18:28:31 +01:00
1dbb557a44
doc/default.nix: List dependencies for building the paper explicitely
2016-01-08 13:41:09 +01:00
21947496d3
Add readme file for paper
2016-01-08 13:12:55 +01:00
fd541c3270
Add configuration for pandoc-crossref
2016-01-08 13:12:55 +01:00
47b351a7f0
Add pandoc-crossref
2016-01-08 13:11:04 +01:00
c2ad295522
Add pdf/html targets for convenience
2016-01-08 13:11:04 +01:00
3ea9721184
Add default doc setup
2016-01-08 13:11:04 +01:00
