Coder Social home page Coder Social logo

vacstay / svg-extension Goto Github PK

View Code? Open in Web Editor NEW

This project forked from guinp1n/svg-extension

0.0 0.0 0.0 520 KB

This is a Google Chrome extension that helps creating sticker(labels) images for using in the installation instruction documents. You can start it either from HVAC–tool page or standalone.

Home Page: https://guinp1n.github.io/svg-extension

JavaScript 97.17% CSS 2.12% HTML 0.71%

svg-extension's Introduction

Label generator (svg-extension)

This is a Google Chrome extension that helps creating sticker(labels) images for using in the installation instructions documents. If the extension starts correctly, you will see:

  • 'Labels...' button will appear next to the interface on the hvac-tool pages (in the System View)
  • Clicking the 'Labels...' button will open a new window (new tab) with the labeling pictures (stickers) and connect-box (connect wires to the box) pictures.
    • Clicking the extension icon (in the Chrome top bar) will open a new window with some default Labels...
    • in the Extensions list you will see the 'cat' icon of the 'svg-extension'

Installation

Note 1: It should not be necessary to remove previous version of the extension. Note 2: Since this extension is not published in the Chrome WebStore, there is only one way to download and install it: from a ZIP archive.

Download

Goto the GitHub page of this project (if you are reading this, you are already at this page). Make sure that you are in the correct branch of the GitHub. At the moment it is: https://github.com/tadodotcom/InstallationsAndHVACDatabase/tree/label-generator-v1.5

From the GitHub, click the tab '< > Code'. When the 'Code' page is loaded, at the top-right you will notice a large green button 'Code'.

  1. Click the big green 'Code' button and in the drop-down list click the 'Download ZIP' item.
  2. Save the ZIP file to your local folder.
  3. Open your file manager and navigate to the downloads folder.
  4. Find your downloaded ZIP archive file.
  5. Unpack the archive into a folder (right-click the file and select 'Extract here')
  6. Goto the Chrome browser. Click the puzzle piece-shaped Extensions icon located to the right of Chrome's Omnibox and in the drop-down list click 'Manage Extensions'.
  7. From the Extensions page enable the developer mode by clicking the 'Developer mode' slider.
  8. When the developer mode is on you will see two new buttons: 'Pack extension' and 'Load unpacked'.
  9. Click the 'Load unpacked' button and navigate to the folder where the ZIP archive is extracted to (and click the 'Open' button in the dialog window to confirm).

Correctly installed 'svg-extension' should show up in the list with the 'cat' icon.

Refresh(F5) the hvac-tool page to let the svg-extension start working on it. If the extension starts correctly, you will see:

  • 'Labels...' button will appear next to the interface on the hvac-tool pages (in the System View)
  • Clicking the 'Labels...' button will open a new window (new tab) with the labeling pictures (stickers) and connect-box (connect wires to the box) pictures.
    • Clicking the extension icon (in the Chrome top bar) will open a new window with some default Labels...

How to start the script

There are two ways to start the extension, once it is installed in your Chrome browser:

  1. From the hvac-tool page: by clicking the 'Labels...' button on the hvac-tool system page
  2. From outside the hvac-or dicrectly, by clicking the extension icon (in the Chrome top bar).

What can it do

You can edit the labels with the Label generator, make screenshot with means of your OS / browser and paste the screenshot in the instructions document. OR You can save the picture as a file (.svg or .png*). **Bug: to save a .png you need to click the link *****

Outside the hvac-tool, the Label-generator page opens with some default stickers. From the hvac-tool (when you click on the 'Labels...' button), the page opens with calculated stickers. The header will contain the systems name and manufacturer.

The page contains stickers for all devices and connect-box pictures for some devices.* *Starting from v1.4

You can change how the stickers look and labelled:

  • hide sticker
  • dash (make the arrowline and eclosing circle dashed)
  • edit the writing text and:
    • if the length of the writing is longer than 3, the enclosing circle will be removed
    • if the writing is empty, the connect-box picture wire will be removed
    • if the wiring requires a bridge, the connect-box picture will be updated with the bridge
      • if the bridge is not supported, it will be yellow

Under each picture on the page there will be two links: labeling.svg and labeling.png. Hint: first time you need to click the link twice to download the image file.

svg-extension's People

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.