Giter Club home page Giter Club logo

1ce-icons-for-plantuml's Introduction

1ce-icons-for-plantuml

Набор спрайтов и макросов по объектам платформы 1С:Предприятие для использования в диаграммах PlantUML.

example

Начало работы

Обратите внимание, что работать с этой библиотекой можно либо локально, либо через интернет.

Локально

Работа локально позволяет не зависеть от интернета и вносить изменения в библиотеку самостоятельно.

  • клонировать репозиторий
  • в начале вашего puml-файла добавить директивы импорта
!include <Путь>/dist/common.puml
!include <Путь>/dist/v8_Catalog.puml
и т.д.

При работе локально вместо подключения нескольких отдельных файлов с префиксом v8_ можно подключить единственный файл all.puml

Через интернет

  • в начале вашего puml-файла добавить директивы импорта (обращайте внимание на версию):
!define v8_PUML https://raw.githubusercontent.com/ovcharenko-di/1ce-icons-for-plantuml/0.2.0/dist
!include v8_PUML/common.puml
!include v8_PUML/v8_Catalog.puml
и т.д.

ВНИМАНИЕ! При работе через интернет необходимо подключать каждый файл отдельно.

Доработка

Принимаются идеи и пожелания по развитию!

Добавить поддержку нового объекта метаданных самостоятельно нетрудно. Для этого необходимо:

  • в каталоге dist создать файл для нового объекта метаданных путем копирования имеющегося
  • в новом файле:
    • заменить спрайт. О том, как как из png создать спрайт, см. документацию). Спрайты могут быть разного размера, но 16x16 вполне хватает.
    • переопределить названия макросов (при изменении сигнатуры нужно обязательно учесть это в файле common.puml и проверить все остальные макросы)
  • указать путь к новому файлу в файле all.puml
  • направить Pull Request

Благодарности

  • @EvilBeaver за доклад на IS 2021, который натолкнул меня на идею создания этой библиотеки
  • авторам библиотек plantuml-stdlib и AWS-PlantUML, которые были взяты за образец.

1ce-icons-for-plantuml's People

Contributors

ovcharenko-di avatar johnydeath avatar

Stargazers

 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.