rdflib 2.3.0 → 2.3.1

package/README.md

@@ -63,6 +63,36 @@ installed.
 npm install --save rdflib
 ```
 
+## Serializer flags
+
+The Turtle/N3/JSON‑LD serializers accept an optional `flags` string to tweak output formatting and abbreviation behavior.
+
+- Pass flags via the options argument to `serialize(...)`:
+
+```ts
+import { graph, serialize, sym } from 'rdflib'
+
+const kb = graph()
+const doc = sym('http://example.com/doc')
+// ... add some statements ...
+
+// Example: prevent dotted local parts in prefixed names
+const turtle = serialize(doc, kb, doc.value, 'text/turtle', undefined, { flags: 'o' })
+```
+
+Common flags used internally (you can combine them, e.g. `'o k'`):
+
+- `s` `i` – used by default for Turtle to suppress `=`, `=>` notations
+- `d e i n p r s t u x` – used for N-Triples/N-Quads to simplify output
+- `dr` – used with JSON‑LD conversion (no default, no relative prefix)
+- `o` – new: do not abbreviate to a prefixed name when the local part contains a dot. This keeps IRIs like
+  `http://example.org/ns/subject.example` in `<...>` form instead of `ns:subject.example`.
+
+Notes:
+
+- For Turtle and JSON‑LD, user‑provided flags are merged with the defaults so your flags (like `o`) are honored.
+- By contrast, passing `'p'` disables prefix abbreviations entirely (all terms are written as `<...>` IRIs).
+
 ## Contribute
 
 #### Subdirectories