buildingSMART / buildingSMART/BCF-XML

[Question] Are snapshots mandatory for a viewpoint in BCF 2.1?

Open
#399 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
PowerShell
Stars
261
Forks
91
PR merge metrics
No merged PRs in 30d

Description

BCF 2.1 topic documentation says

> The folder **contains** the following files ...

Later, the Viewpoint section states that Snapshot is optional.

Can you clarify if the snapshot is mandatory or not?

I'm asking because a vendor outputs an error if my topics generated with IfcOpenShell don't have a snapshot.
It took me a lot of time to figure out that this was the issue since the tech support only told me to check the specification, which I thought I was following correctly.

---

As a quick heads up, some of the test cases in the release_2_1 branch are not BCF 2.1 compliant since they use the "Viewpoint_.bcfv" and "Snapshot_.png" filenames instead of the "viewpoint.bcfv" and "snapshot.png".

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the BCF 2.1 topic documentation and its Viewpoint section, then inspect the release_2_1 branch test cases using Viewpoint_.bcfv and Snapshot_.png. Confirm the intended snapshot requirement and filename rules, then update the documentation or tests so the specification and examples agree.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.