npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

in-text-citations-parser

v1.0.3

Published

Extract inline citations from stream

Downloads

4

Readme

in-text-citations-parser

Creates a stream from PDF

Node.js module for parsing in-text citations from streams.

Use it with pdf-stream module.

Table of Contents

Install

  npm i in-text-citations-parser --save

Usage

new XMLTransform() converter

  'use strict';
  
  const fs = require('fs');
  const pdf_stream = require('pdf-stream');
  global.XMLHttpRequest = require('xhr2'); // for PDFJS
  const parser = require('in-text-citations-parser');
  const ParserTransform = parser.ParserTransform;
  const XMLTransform = parser.XMLTransform;
  const FileTransform = parser.FileTransform;

  let configs = [{
    file: './CRIS2016_paper_40_Parinov.txt',
    uri: 'http://dspacecris.eurocris.org/bitstream/11366/526/1/CRIS2016_paper_40_Parinov.pdf',
    handle: 'repec:rus:mqijxk:43',
    prefix: 'pannot1'
  },
  // ...
  ];

  configs.map((config)=> {
    fs.createReadStream(config.file)
      .pipe(new ParserTransform('gost'))
      .pipe(new XMLTransform({
        uri: config.uri,
        handle: config.handle,
        prefix: config.prefix
      }))
      .pipe(new FileTransform({
        outdir: './out',
        prefix: config.prefix,
      }));    
  });

new XMLinTextRefTransform() converter

  'use strict';
  
  const fs = require('fs');
  const pdf_stream = require('pdf-stream');
  
  const parser = require('in-text-citations-parser');
  const ParserTransform = parser.ParserTransform;
  const XMLinTextRefTransform = parser.XMLinTextRefTransform;
  const FileTransform = parser.FileTransform;
  
  let file = './CRIS2016_paper_40_Parinov.txt';
  //let file = './2014_Nevolin_rfbr.txt';
  //let file = './pdt-journal_112_145.txt';
  const text_stream = fs.createReadStream(file);
  
  text_stream
    .pipe(new ParserTransform('gost'))
    .pipe(new XMLinTextRefTransform())
    .pipe(new FileTransform({
      outdir: './out',
      prefix: 'CRIS2016_paper_40_Parinov_intextref',
    }))
  ;

API

All methods are streams, use them with .pipe().

new ParserTransform(options)

alternative usage: new ParserTransform('gost')

Find citations in text.

Options:

  • options — String with name of predefined style (gost) or RegExp or Object, with params:
    • regexp — Regular expression for citation match;
    • normalize — Object with functions for normalizing the matched citations.

new XMLTransform(options)

Convert annotations to XML in object mode stream.

Options:

  • uri — xml.Linkage.Object.To.Uri;
  • handle — xml.Linkage.Object.To.Handle;
  • prefix — xml.DocID.

new XMLinTextRefTransform()

Convert annotations to XML format in-text references for CiteEcCyr project, in object mode stream.

new FileTransform(options)

Save XMLs objects to XML files.

Options object:

  • outdir — output directory;
  • prefix — file prefix.

Contribute

Contributors are welcome. Open an issue or submit pull request.

Small note: If editing the README, please conform to the standard-readme specification.

License

Apache 2.0

© Sergey N