Coder Social home page Coder Social logo

ixbrl-bookmarklet's Introduction

iXBRL Bookmarklet

A “bookmarklet” is a browser bookmark that adds extra functionalities to the browser when it’s clicked. In this particular case, it will create an extra table to display XBRL related information about the document you are visualizing. It’s important to mention that any behaviour added by this, won’t affect permanently your browser or document, and will be lost when you change to another page (or even if you refresh it).

How to create a bookmarklet ?

Just create a new bookmark in your browser and copy the code stored in the file named iXBRL-bookmarklet-one-line.js into the URL section.

How to use it ?

When you are visualizing an iXBRL file (which is a HTML file) in your Browser, run the bookmark you have created. Now, while navigating over your iXBRL document, when you hover over any item that contains a XBRL tag, a table with related information should appear.

Note that only element that are visible in the iXBRL file will be displayed, since you need to hover them. If there are xbrl tags that are hidden and not displayed anywhere in the file, you won't be able to reach them and display the information table.

How to contribute ?

Do you want to make your own changes to the bookmarklet? That's great! The entire logic to make this bookmarklet work is stored in the file named iXBRL-bookmarklet-code.js in src folder. You can work on that one and make all the changes you need. Then, you can run the node createBookmarklet.js to convert the previous file into a one-line JavaScript code, that can be easily copy-pasted into a bookmark. This will create a new iXBRL-bookmarklet-one-line.js file inside your src folder. Don't forget to submit your updates or fixes vía a Pull Request.

Disclaimer

This bookmarklet was created as a tool to help us debug, and easily inspect the content, of our own iXBRL exports. It may not work correctly with HTML files that are structured differently.

ixbrl-bookmarklet's People

Contributors

agustinsilverfin avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.