Commit Graph

64 Commits

Author SHA1 Message Date
Felix Krause eee45683ea Simplified docs, fixed some links. v2.1.0 2023-12-30 16:37:02 +01:00
Felix Krause c509953289 Documentation overhaul.
* submodule docs are now located at /api/yaml/<name>.html instead of
   /api/<name>.html.
 * can now simply link to symbols in other modules.
 * fixed some links
 * fixed quickstart example list
 * added quickstart item displaying the new style api
 * fixed a bug in presenter that doubled a line in literal/flow style
2023-11-27 23:05:05 +01:00
Felix Krause a698289223 New pragmas for customizing presentation
* added yaml/style that defines representation pragmas
   `scalar` and `collection`
 * implemented those pragmas
 * updated docs. also fixes some invalid links in docs
2023-11-11 15:36:10 +01:00
Felix Krause 03c95da97c Presenter improvements and new features
* Presenter now tries to write style given in event
 * Can write single quoted
 * several fixes to line length handling
 * sever other presenter fixes
 * updated server deps
 * updated server code to use new presenter features
   (or rather, not use, as the server *should* alter the
   input style instead of outputting it as-is)
2023-11-11 13:20:56 +01:00
Felix Krause a2f289a8bc Improved documentation.
* also renamed canonicalDumper to explanatoryDumper
   because there's nothing canonical about it
2023-11-10 21:24:04 +01:00
Felix Krause fe4449aaec Fixed server, improved docs
* made docs server compile again
 * improved migrating documenattion
 * improved CSS for mobile devices
 * fixed GitHub link
2023-09-04 22:48:04 +02:00
Felix Krause 879c7adfc0 Updated documentation. Fixed CI 2023-08-30 22:48:58 +02:00
Felix Krause 940675a52e Reworked loading API
* moved load procs to yaml/loading.nim
 * moved input YamlStream into ConstructionContext
 * made ConstructionContext a non-ref object
 * harmonized code style & comments
 * renamed yaml/serialization.nim to yaml/native.nim
2023-08-29 23:23:15 +02:00
Felix Krause 18fc8ba3f5 Reworked dumping API
* removed default value objects,
   use Nim2 default vaules for fields instead.
 * moved dump procs to yaml/dumping and introduced Dumper
 * modified serialization procs to use ctx as first argument,
   so that prefix calls can be used
 * changed defaults for presentation to be more like other
   YAML implementations, e.g. no directives by default.
 * Removed deprecated procs in DOM API
 * Removed PresentationStyle – use the setXStyle procs of Dumper
   instead.
 * Fixed some warnings emerging from transitioning to Nim2
2023-08-29 20:46:26 +02:00
Felix Krause 189844a72b Rewrote large parts of presenter
* PresentationOptions has gained more fine-tuning options:
   * directivesEnd: specifies when `---` is written. ref #135
   * containers: specifies whether containers use block or flow style
   * suppressAddrs: if set, suppresses output of attributes
   * quoting: specifies how strings should be quoted
   * condenseFlow: specifies whether flow sequences should be on a
     single line
   * explicitKeys: specifies whether mapping keys should always have '?'
 * PresentationStyle is now a list of presets that set
   multiple options in PresentationOptions.
 * Does not output trailing spaces anymore. ref #135
 * Writes compact notation, i.e. a mapping in a sequence starts on the
   line with the sequence's `-`, unless attributes are written
 * Added tests for the presenter
 * Existing code might change behavior because of whitespace, `---` and
   compact notation. The API has been extended so that existing code is
   affected as little as possible.
2023-07-31 19:16:24 +02:00
Felix Krause 741fd18047 Deprecated DOM API, YamlNode now supported by serialization API
* implements #48
 * also fixes #108
 * updated docs
2022-06-05 12:27:19 +02:00
Felix Krause 5aa39aa0f1 webdocs: have code always on left side in quickstart 2022-06-04 13:03:49 +02:00
Felix Krause d80b6fb52e improved webdocs; added nix flake for webdocs 2022-06-04 01:45:41 +02:00
Felix Krause 1346467b42 fixes #93 2021-05-18 00:31:47 +02:00
Felix Krause 329e18e44c removed obsolete TagLibrary type. control tag directives when dumping. fixes #95 2021-03-23 18:51:05 +01:00
Felix Krause e3e810fce0 all tests green again 2020-11-10 19:07:46 +01:00
Felix Krause 951efdf18e added {.sparse.}. fixes #82 2020-06-26 23:21:22 +02:00
Felix Krause e4b3e8347a updated docs 2020-06-26 22:36:52 +02:00
Felix Krause bce3981849 replaced field/object macros with annotations; fixes #66 2020-06-26 21:29:41 +02:00
Hayden 20bf995ae6 Fix link to YAML 1.2 Schema 2019-09-06 16:24:45 +02:00
Felix Krause 294fc875bd Testing Ground uses HTTPS now 2016-11-30 20:31:36 +01:00
Felix Krause 86845f9bd5 Documented !!timestamp 2016-11-08 21:15:14 +01:00
Felix Krause 05c4aa733c Documentation update
* Added schema documentation
 * Documented setDefaultValue
 * Updated some tag URIs
2016-11-01 12:40:53 +01:00
Felix Krause 6a3d876f7e Generate testing.html with rst
* use same html template as other pages
 * Also improved .gitignore
2016-10-27 18:57:32 +02:00
Felix Krause fd05f828ad Updated serialization doc 2016-10-20 18:12:35 +02:00
Felix Krause 29352fa4fe Use global tag handle for NimYAML
* NimYAML now uses the tag prefix tag:nimyaml.org,2016:
 * That tag handle is shortened to !n! when presenting
 * Also fixed some minor bugs dealing with tag handles
2016-10-10 20:16:54 +02:00
Felix Krause 4bde3a7986 Fixed issues in quickstart and taglib
* Updated expected YAML in 02
 * Fixed duplicate TagIds in taglib
2016-10-09 11:48:52 +02:00
Felix Krause 0f2e077b87 Added automatic test for quickstart snippets
* There are errors which indicate real bugs!
2016-10-08 23:35:33 +02:00
Felix Krause 5d4ec6c43f Numeric sorting also for snippet files 2016-10-08 21:08:12 +02:00
Felix Krause 9f7e87e935 Ordered snippets with file system hierarchy 2016-10-08 20:57:53 +02:00
Felix Krause 31ac201e41 doc: extracted examples to own files 2016-10-08 18:38:27 +02:00
Felix Krause 9fffc7b127 Fixed links in documentation 2016-09-22 14:06:54 +02:00
Felix Krause 5dfc984913 Updated documentation for new structure 2016-09-21 21:20:57 +02:00
Felix Krause 650b858861 Updated serialization documentation 2016-09-20 18:48:14 +02:00
Felix Krause 7cad7b5478 Fixed and properly implemented variant objects 2016-06-08 19:15:50 +02:00
Felix Krause 2ce212b79a NimYAML 0.5.0
* Updated changelog, readme and nimble file
 * moved nimble file from nimyaml.nimble to yaml.nimble because
   the nimble package has been renamed
 * Updated documentation about nimble package
2016-06-05 19:41:09 +02:00
Felix Krause 48aeff20c0 Use variant object types for heterogeneous data
* Made variant object types work (really this time)
 * Added `markAsImplicit`
 * Implemented implicit variant object types
 * Added documentation
2016-06-05 19:29:16 +02:00
Felix Krause c3810fbb22 Made server output syntax-highlighted YAML 2016-05-12 15:35:29 +02:00
Felix Krause 273093e390 improved setTagUri
* renamed setTagUriForType to setTagUri
 * generated TagId is now const (can be used in case etc)
 * Uses compile-time counter independent from tag library
2016-04-21 18:58:53 +02:00
Felix Krause 4ca4b2c87e Support nil strings and seqs 2016-04-04 21:21:24 +02:00
Felix Krause 58b9b92895 Support int, uint and float types. 2016-04-04 20:44:16 +02:00
Felix Krause f2c83cc170 Support array types. Updated documentation 2016-04-03 11:29:49 +02:00
Felix Krause 7063e72ace Added advanced example to index.html 2016-03-25 23:12:00 +01:00
Felix Krause 06faf4966d Object fields get the tag !nim:field. Fixes #12. 2016-03-25 21:38:28 +01:00
Felix Krause d3053f381f Improved quickstart examples 2016-03-21 21:15:38 +01:00
Felix Krause 537ba1ca01 Improved quickstart documentation 2016-03-20 22:58:39 +01:00
Felix Krause ce4349f847 Fixed link in generated documentation 2016-02-25 22:34:23 +01:00
Felix Krause 27670f63c9 Implemented and documented DOM 2016-02-22 21:56:30 +01:00
Felix Krause 7eca93f988 Server: Added possibility to show token stream 2016-02-18 15:52:19 +01:00
Felix Krause a028b43858 Doc: Added link to git repo on index 2016-02-16 20:44:40 +01:00