ADR-0005: 모델 내장 SVG를 저장 형식으로 사용

이후 변경

  • 2026-10-13: 저장되는 SVG에 모델과 그림 말고도 서브셋 글꼴(쓰인 글리프만 남긴 것)이 들어가게 됐다. 글꼴이 설치되지 않은 뷰어에서도 텍스트가 레이아웃한 폭에 맞게 하려는 것이다. → ADR-0026
  • 2026-10-22: 용어를 SW 엔지니어의 말로 고쳤다(뜻은 그대로). → 01-architecture
  • 2026-10-25: <metadata> 안 모델 요소의 네임스페이스 URI는 저장소 주소, 접두어는 ans. 프로토타입의 version: 0 파일은 열지 않는다 → ADR-0035
  • 2026-11-03: 모델 요소에 그림 부분의 지문(drawing-sha256, SHA-256)을 적어, 다른 도구가 그림만 고친 파일을 열 때 알린다. 모델을 뺀 순수 SVG는 저장 파일에서 <metadata>만 뺀 것이다 → ADR-0045

배경

다이어그램을 저장할 파일 형식을 정해야 한다. Obsidian 노트에 그림을 바로 넣어 보고 싶고, 다시 열어 편집도 할 수 있어야 한다. drawio-obsidian은 SVG 안에 다이어그램 정보를 넣어 저장하는데, 이 방식이 마음에 든다.

결정 기준

  • 플러그인이 없어도 어디서나 그림으로 보여야 한다. (R-OBS-07, R-FMT-01)
  • 같은 파일을 다시 열어 편집할 수 있어야 한다.
  • 파일 하나로 관리되어야 한다 (그림과 원본이 따로 놀지 않도록).

검토한 대안

원본 파일(JSON 등) + 이미지 내보내기

  • 장점: 원본 형식이 단순
  • 단점: 파일이 두 개, 원본을 고치고 내보내기를 잊으면 그림과 원본이 달라짐, 노트에 바로 넣을 수 없음

그림만 SVG로 저장하고 열 때 그림을 역해석

  • 장점: 파일 하나
  • 단점: 역해석(SVG 요소에서 모델 복원)이 불안정하고, 다른 도구가 고친 SVG를 해석할 수 없음

모델 내장 SVG

  • 장점: 파일 하나가 그림이자 원본, 어떤 SVG 뷰어에서도 보임
  • 단점: 다른 도구로 그림만 고치면 다시 열 때 사라짐, 파일이 조금 커짐

결정

저장 파일은 SVG이고, 다이어그램 모델을 SVG의 <metadata> 안에 넣는다.

  • 모델이 원본(single source of truth)이다. 열 때는 모델만 역직렬화하고, 저장할 때마다 그림 요소를 모델에서 다시 렌더링한다.
  • 모델이 없거나 손상된 SVG는 편집 불가로 처리한다. 그림을 역해석하지 않는다.
  • 세부 형식은 01-file-format에 정의한다.

결과

  • 좋아지는 점: Obsidian 노트, 브라우저, 문서 도구 어디서나 그림이 보인다. git에 파일 하나로 관리된다.
  • 감수하는 점: 다른 SVG 편집 도구로 그림만 고친 내용은 보존되지 않는다.
  • 후속 작업: 확장자 → ADR-0006, 모델 직렬화 형식 → ADR-0007