UNPKG

@atjson/source-prism/README.md

Version:

1.07 kBMarkdownView Raw

1# 🌈 @atjson/source-prism
2
3## 💁‍♀️ What is PRISM
4
5PRISM is an acronym for Publishing Requirements for Industry Standard Metadata. The format is used in publishing to provide information about published works, primarily those that are printed in magazines, books, or other media.
6
7Brands at Condé Nast such as the New Yorker, WIRED, and Vogue have versions of their print magazines annotated in PRISM XML that provides necessary metadata for our teams to extract data from.
8
9## 🖍 How to use
10
11Read the XML as a string and pass it directly to the PRISM source:
12
13```typescript
14import PRISMSource from "@atjson/source-prism";
15
16let prism = PRISMSource.fromRaw(xml);
17```
18
19From here, you can do all the things you'd do in other sources, like convert to another source, and render out to other sources.
20
21## 🤷‍♀️ How can I test my XML?
22
23We've supplied a little application alongside this package, which can be run using `npm start` from inside `@atjson/source-prism`. Once the app's running, you can navigate to [`localhost:1234`](http://localhost:1234).

1	`# 🌈 @atjson/source-prism`
2
3	`## 💁‍♀️ What is PRISM`
4
5	`PRISM is an acronym for Publishing Requirements for Industry Standard Metadata. The format is used in publishing to provide information about published works, primarily those that are printed in magazines, books, or other media.`
6
7	`Brands at Condé Nast such as the New Yorker, WIRED, and Vogue have versions of their print magazines annotated in PRISM XML that provides necessary metadata for our teams to extract data from.`
8
9	`## 🖍 How to use`
10
11	`Read the XML as a string and pass it directly to the PRISM source:`
12
13	```typescript
14	`import PRISMSource from "@atjson/source-prism";`
15
16	`let prism = PRISMSource.fromRaw(xml);`
17	```
18
19	`From here, you can do all the things you'd do in other sources, like convert to another source, and render out to other sources.`
20
21	`## 🤷‍♀️ How can I test my XML?`
22
23	We've supplied a little application alongside this package, which can be run using `npm start` from inside `@atjson/source-prism`. Once the app's running, you can navigate to [`localhost:1234`](http://localhost:1234).