metanorma-cli 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5419e7db087c36a77374043a69faa01025d1dda03613cb9ded9c55b535bdbed6
-  data.tar.gz: 86c51d24bc217efc69fb35a0009255af1e360f7c94e6af240ee08972888c51f4
+  metadata.gz: 75433112416d221107bfe4026cfa96eadddee6db08cd443b3a30062a42e2156b
+  data.tar.gz: 0e94f5d9d66bd2feaf6df97f2e5e4967f3182fb0f35b86f2203f231924c75304
 SHA512:
-  metadata.gz: 82a275d58231c0989eab46cf097a486c4bbca98ecc77cc15ae233d7e1fbd73338dc7b56eb2b317670466b114927f684b08977cbbde892e1a39a8e59eba52f548
-  data.tar.gz: 03b818073b6b39ee5545732949714ec2f85a45567ae385a709ab01667d075e57a6e80ec342079e05f0610f9fd6960e84fdc62abd2c1955e4817066bdc2fe78b1
+  metadata.gz: b71badf1d32af2dc89c1eaeb4f4af97f3719503fb6ea88646a15cedea3c30d0cbfc2c67bfdb29131bf735d9b2b00e6de93b14eb948add486ac2a895e3e72fcb5
+  data.tar.gz: d53dbfc4f1999a2f80d02e8351298a48954ac076a8550baa257814c14b67d3dc807ea9bd7cc3e422aec758f3303f220c8d705c7fe7c701bbc3b2ce0abb53bceb

data/docs/usage.adoc

@@ -1,21 +1,75 @@
 = Using the Metanorma CLI
 
-== Usage sample
+== Usage samples
+
+For a single document:
+[source,sh]
+----
+$ metanorma iso-my-standard-document.adoc
+----
+
+or
 
 [source,sh]
 ----
 $ metanorma --type iso -x html iso-my-standard-document.adoc
 ----
 
+if type and extensions are not defined in adoc header
+
 == Full syntax & options
 
+General help message can be shown by `metanorma help`
+
 [source,sh]
 ----
-$ metanorma --type <chosen-type> \
-  [--format input-format] \
-  [--extensions EXT1,EXT2...] \
-  iso-my-standard-document.adoc
+Commands:
+  metanorma collection FILENAME -w, --output-folder=OUTPUT_FOLDER  # Render HTML pages from XML/YAML colection
+  metanorma compile FILENAME                                       # Compile to a metanorma document
+  metanorma config                                                 # Manage configuration file
+  metanorma help [COMMAND]                                         # Describe available commands or one specific command
+  metanorma list-doctypes                                          # List supported doctypes
+  metanorma list-extensions                                        # List supported extensions
+  metanorma new NAME -d, --doctype=DOCTYPE -t, --type=TYPE         # Create new Metanorma document
+  metanorma site                                                   # Manage site for metanorma collections
+  metanorma template-repo                                          # Manage metanorma templates repository
+  metanorma version                                                # Version of the code
+
+Options:
+  -s, [--no-progress], [--no-no-progress]  # Don't show progress for long running tasks (like download)
+                                           # Default: true
+----
+
+Also you can get a help message for a specific command for example `metanorma help compile`:
+
+[source,sh]
 ----
+Usage:
+  metanorma compile FILENAME
+
+Options:
+  -t, [--type=TYPE]                                              # Type of standard to generate
+  -x, [--extensions=EXTENSIONS]                                  # Type of extension to generate per type
+  -f, [--format=FORMAT]                                          # Format of source file: eg. asciidoc
+                                                                 # Default: asciidoc
+  -r, [--require=REQUIRE]                                        # Require LIBRARY prior to execution
+  -w, [--wrapper], [--no-wrapper]                                # Create wrapper folder for HTML output
+  -a, [--asciimath], [--no-asciimath]                            # Keep Asciimath in XML output instead of converting it to MathM
+  -d, [--datauriimage], [--no-datauriimage]                      # Encode HTML output images as data URIs
+  -R, [--relaton=RELATON]                                        # Export Relaton XML for document to nominated filename
+  -e, [--extract=EXTRACT]                                        # Export sourcecode fragments from this document to nominated directory
+  -v, [--version=VERSION]                                        # Print version of code (accompanied with -t)
+  -o, [--output-dir=OUTPUT_DIR]                                  # Directory to save compiled files
+      [--agree-to-terms], [--no-agree-to-terms]                  # Agree / Disagree with all third-party licensing terms presented (WARNING: do know what you are agreeing with!)
+      [--no-install-fonts], [--no-no-install-fonts]              # Skip the font installation process
+      [--continue-without-fonts], [--no-continue-without-fonts]  # Continue processing even when fonts are missing
+  -s, [--no-progress], [--no-no-progress]                        # Don't show progress for long running tasks (like download)
+                                                                 # Default: true
+
+Compile to a metanorma document
+----
+
+A bit more details on options:
 
 `type`:: (mandatory, specified via `--type` or `-t`) takes one of the following types:
 `rfc2`, `rfc3`, `iso`, `gb`, `csd`, `csand`, `m3d`, `rsd`. Each of these corresponds to a
@@ -28,6 +82,8 @@ what has been defined for each standard type. All standards can generate Metanor
 and at least one of HTML (`html`), DOC (`doc`), PDF (`pdf`). Some standards generate alternative
 HTML renderings (e.g. `html_alt` for ISO).
 
+Actual list of supported `types` and `extension`s you can get with `metanorma list-doctypes`
+
 `wrapper`:: create a separate folder for each instance of HTML output generated; the folder is named
 the same as the output file, without the `.html` suffix. Used to make distribution of HTML outputs
 more straightforward.
@@ -47,24 +103,3 @@ $ metanorma -t mpfd mpfd-bpn.adoc
 $ metanorma -t mpfd -r metanorma-mpfd mpfd-bpn.adoc
 ----
 
-== Command-line help
-
-[source,sh]
-----
-$ metanorma help
-Commands:
-  metanorma collection FILENAME -w, --output-folder=OUTPUT_FOLDER  # Render HTML pages from XML/YAML colection
-  metanorma compile FILENAME                                       # Compile to a metanorma document
-  metanorma config                                                 # Manage configuration file
-  metanorma help [COMMAND]                                         # Describe available commands or one specific command
-  metanorma list-doctypes                                          # List supported doctypes
-  metanorma list-extensions                                        # List supported extensions
-  metanorma new NAME -d, --doctype=DOCTYPE -t, --type=TYPE         # Create new Metanorma document
-  metanorma site                                                   # Manage site for metanorma collections
-  metanorma template-repo                                          # Manage metanorma templates repository
-  metanorma version                                                # Version of the code
-
-Options:
-  -s, [--no-progress], [--no-no-progress]  # Don't show progress for long running tasks (like download)
-                                           # Default: true
-----

data/lib/metanorma/cli/site_generator.rb

@@ -78,6 +78,7 @@ module Metanorma
           format: :asciidoc, output_dir: build_asset_output_directory(source)
         )
 
+        options[:baseassetpath] = Pathname.new(source.to_s).dirname.to_s
         Metanorma::Cli::Compiler.compile(source.to_s, options)
       end
 

data/lib/metanorma/cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Cli
-    VERSION = "1.5.0".freeze
+    VERSION = "1.5.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug