From 6b462201198afad7b4f16f7c057000dcfb4a4df6 Mon Sep 17 00:00:00 2001 From: Neel Smith Date: Thu, 16 Sep 2021 02:20:30 -0400 Subject: [PATCH] Support new version of CitableObject --- Project.toml | 6 +++--- docs/make.jl | 2 +- docs/src/index.md | 10 ++++++++-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/Project.toml b/Project.toml index 72a5942..2e6701f 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "CiteEXchange" uuid = "e2e9ead3-1b6c-4e96-b95f-43e6ab899178" authors = ["Neel Smith "] -version = "0.4.2" +version = "0.4.3" [deps] CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b" @@ -13,8 +13,8 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" [compat] CSV = "0.8, 0.9" -CitableObject = "0.6" +CitableObject = "0.7" DocStringExtensions = "0.8" -Documenter = "0.26, 0.27" +Documenter = "0.27" HTTP = "0.9" julia = "1" diff --git a/docs/make.jl b/docs/make.jl index 61f4101..cf4bcf5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -20,7 +20,7 @@ using CiteEXchange makedocs( sitename = "CiteEXchange", pages = [ - "Home" => "index.md", + "Overview" => "index.md", "API documentation" => "apis.md" ] diff --git a/docs/src/index.md b/docs/src/index.md index ad85399..b130459 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -2,6 +2,8 @@ *Parse strings and files in CEX format.* +Cite EXchange format (CEX) is a plain-text format for serializing citable scholarly resources. + ## Quick example Plain-text CEX files are composed of one or more blocks defined by a CEX header line. @@ -33,12 +35,16 @@ blocklist[1].lines ### Work with an array of `Block`s -CiteEXchange.jl also has functions that work with arrays of `Block`s. E.g., you can see what types of blocks are present, and find all data for a given type of block. +CiteEXchange also has functions that work with arrays of `Block`s. You can see what types of blocks are present. ```@example simple blocktypes(blocklist) ``` +You can find all data for a given type of block. + ```@example simple datafortype("ctscatalog", blocklist) -``` \ No newline at end of file +``` + +A typical work pattern might be to read an array of blocks, see what types of block are included, and then use an appropriate module to process blocks depending on their type (e.g., use the `CitableCorpus` module to read a `ctsdata` or `ctscatalog` block). \ No newline at end of file