n3 3.0.0-alpha.1 → 3.0.0-alpha.3

package/README.md

@@ -217,23 +217,21 @@ The parser can output a backwards chaining rule such as `_:q <= _:p.` in two way
 const parser = new N3.Parser({ isImpliedBy: true });
 ```
 
-By default, an empty formula `{}` is kept as a blank node graph term.
-The [N3 spec tests](https://w3c-cg.github.io/N3/tests/)
-(and the direction discussed in [w3c-cg/N3#185](https://github.com/w3c-cg/N3/issues/185))
-read it as the boolean literal `"true"^^xsd:boolean` instead;
-the `emptyFormulaAsTrue` flag enables that behavior:
+An empty formula `{}` is read as the boolean literal `"true"^^xsd:boolean`,
+following the [N3 spec tests](https://w3c-cg.github.io/N3/tests/)
+(and the direction discussed in [w3c-cg/N3#185](https://github.com/w3c-cg/N3/issues/185)).
+Setting the `emptyFormulaAsTrue` flag to `false` keeps it as a blank node graph term instead:
 ```JavaScript
-const parser = new N3.Parser({ format: 'text/n3', emptyFormulaAsTrue: true });
+const parser = new N3.Parser({ format: 'text/n3', emptyFormulaAsTrue: false });
 ```
 
-In N3 documents, the parser by default rescopes blank node labels
-in lists and blank node property lists, in addition to formulas,
-so `_:a` inside a list does not co-reference `_:a` outside of it.
-The `formulaScopedBlankNodes` flag scopes blank node labels to formulas only,
-matching N3's formula-scoped blank node semantics
-(this will become the default in the next major version):
+In N3 documents, blank node labels are scoped to formulas,
+matching N3's formula-scoped blank node semantics,
+so `_:a` inside a list or blank node property list co-references `_:a` outside of it.
+Setting the `formulaScopedBlankNodes` flag to `false` restores the legacy behavior
+of also rescoping blank node labels in lists and blank node property lists:
 ```JavaScript
-const parser = new N3.Parser({ format: 'N3', formulaScopedBlankNodes: true });
+const parser = new N3.Parser({ format: 'N3', formulaScopedBlankNodes: false });
 ```
 
 ### From an RDF stream to quads
@@ -331,10 +329,10 @@ const writer1 = new N3.Writer({ format: 'N-Triples' });
 const writer2 = new N3.Writer({ format: 'application/trig' });
 ```
 
-A `baseIRI` argument makes the writer abbreviate IRIs relative to that base in Turtle/TriG serializations. Pass `writeBase: true` to also write the base as an `@base` directive at the top of the document (N-Triples and N-Quads remain directive-free).
+A `baseIRI` argument makes the writer abbreviate IRIs relative to that base in Turtle, TriG and N3 serializations, and write the base as an `@base` directive at the top of the document so the output parses back to the same IRIs (N-Triples and N-Quads remain directive-free). Pass `writeBase: false` to omit the directive, for instance for a document that will be served at its base IRI:
 
 ```JavaScript
-const writer = new N3.Writer({ baseIRI: 'http://example.org/', writeBase: true });
+const writer = new N3.Writer({ baseIRI: 'http://example.org/', writeBase: false });
 ```
 
 ### From quads to an RDF stream