-
Notifications
You must be signed in to change notification settings - Fork 63
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
How do you refer to files in the DTCG format? #164
Comments
I’m currently attempting to form some nomenclature for this at my company and what I’ve been pushing is token source files for the canonical |
Perhaps off topic for this thread, but additionally we’re calling the selected collection of token source files required to render a specific token document (e.g. base + mobile sizes + dark palette) a token theme and the collection of all token source files and the build config a token package. |
I like @jeromefarnum 's idea: "source" makes a lot of sense to me. I'm not the best English labeler though. Another though is to clearly stand that's a Standard: On a side note, I like the extended view @jeromefarnum proposes with |
I love the idea of a "token source file" as the "source" term makes it easy to understand the file contains "raw" tokens that are transformed yet. Among all your proposals @c1rrus I prefer "Design Tokens files". |
I tend to refer to them as “source” files as well. “Token source file” or “design token source file” makes sense to me. |
We call them "token JSON" or "token source files." Collectively they're the "source of truth." When we distinguish between files in this format and our original format, we use phrases like "W3C token JSON" (or, if you're trying to be funny, "DTF file") and "proprietary token JSON." After being processed by tools, we produce "the generated code" and that goes to NPM in "token packages." So, a very different definition of "token package" than Jerome mentioned a few comments up! |
I also like the idea of "Design Tokens source files", a way of acknowledging that these files are there to be a single source of truth for design decisions cut into several pieces that we call "tokens". |
I don't use the term "source" because the manifest could be built in a variety of ways:
|
I like what @CITguy is proposing. Since "source file" could also mean the file that the design token's end user refers to when they consume them, I think "manifest" makes more sense. As for the name part, one thing that I have recently experienced in my team is that the term |
We can't call it a "manifest" because that means something entirely different. A manifest is a list of cargo. In software it means a file that either lists or describes other files and that's not what a design token file is at all. If someday you had one token file for light theme and one token file for dark theme, you might also have a third file that just lists the other two, and that would be a manifest. {
"light": "light.tokens.json",
"dark": "dark.tokens.json"
} NPM's |
@TravisSpomer That makes sense too! Hmm, I'm not a fan of the source but now I'm not a fan of anything lol. |
@TravisSpomer actually, I don’t think your packages and our packages are all that different. Our token packages actually end up as NPM packages, and include the rendered token documents in a This allows projects using our tokens to either import the prebuilt token documents directly, or import a subset (or all) of the token source files for use in their own token packages. |
After some empirical implementations of the spec I ended up missing naming for more than files themselves. From a library and API editor perspective, I missed names for:
I don't hold a strong opinion on any particular proposition made previously, but I think we must consider giving cohesive names to such close concepts. |
Just catching up on all the replies here. Really interesting stuff! Thanks everyone for sharing. I wonder if terms like "source" or "manifest" files refer to broader concepts that are not unique to the DTCG file format though. For example, the files used with current versions of Style Dictionary could be considered "source" token files (since they contain the source design tokens that SD translates into whatever output formats you need). However, their internal structure does not follow our spec, so they're a different file format. I suppose that doesn't necessarily rule out adopting a name along the lines of "DTS (Design Token Source)" or the other variations that @icona79 suggested. But, as @CITguy pointed out, these files are not necessarily the source of your design token data. In other setups, they might just be used to transfer design token data between tools (So, "Design Token Exchange Files" or DXF, perhaps? 😛) I therefore wonder if it's best to avoid names that describe/assume a specific kind of use-case or workflow. (Aside: It's definitely useful to continue the discussion on broader terminology. However, I'm keen to get more insights and ideas on how to differentiate DTCG format design token files from other kinds of token file formats that are out there.) This comment from @TravisSpomer's also caught my attention:
I've noticed variations of "W3C" format being used to refer to files that follow the DTCG spec elsewhere too. For example "Design Tokens Generator" can save out tokens in various formats and uses the label "W3C" for the DTCG ones: Trouble is, that's misleading. While the DTCG is a W3C community group, it is not a W3C Working Group. The technical reports published by the DTCG are therefore not W3C Standards nor are they on the W3C Standards Track. I therefore think that the DTCG needs to discourage referring to the file format as "W3C design token files" or similar. However, the above screenshot from the Design Token Generator does nicely demonstrate the need for some kind of name: If we shouldn't use "W3C", then what should go onto that tab? Perhaps "DTCG files" can be a candidate?
Thoughts? Better ideas? Btw, whatever we land on, should we perhaps also update the suggested file extension in the spec to match? For example, if we wanted to encourage people and tools to refer to these files as "DTCG files", then |
What if we were straightforward with it... Design Tokens Schema (DTS)
Design Tokens JSON (DTJ)
Design Tokens package (DTP)
|
Maybe best to google the three letter acronyms before adopting one. :) Plain |
Crowdsourced slang terms defined on social dictionary sites (we all know which one I'm referring to) are excluded as they do not represent the general industry as a whole. Regardless, many acronyms have overlapping definitions, depending on contextual use. Here's a quick set of results for each acronym. |
My only concern is what people will get as results on search engines for any given acronym. I don't really think it is an issue if there is overlap with an acronym from an unrelated industry. If possible it would be good to avoid :
|
+1 - I'm with this one too. There might be non-technical people contributing or referring to these files, so keeping it in simple and friendly terms is ideal. I think it also avoids getting too "specific" which is prone to not being as scalable or future proof. |
A bit late to the party here, but I wanted to give my $0.02 in case it helps. The distinction we draw most often is not between the output from tokens, but rather the tokens expressed in Figma (stored as Figma variables) and our source-of-truth token files, which have |
Great topic! I’d like an answer for this as well. We’ve been using “Design Tokens JSON” here, but I would gladly switch to whatever becomes the official name. I think it’s important to distinguish between the organising body (“Design Tokens Community Group” or “DTCG”), the specification (“Design Tokens Format Module”?), and the actual JSON file artefacts. I think it’s good to mention that it’s JSON, but “Design Tokens file” also seems good. |
Our spec is officially titled "Design Tokens Format Module" and it recommends a file extension of
.tokens
or.tokens.json
. But when you talk about these files with your colleagues and friends, what do you call them?Names I've read / heard / used so far are:
It would be interesting to hear what name(s) you've all been using.
I'm asking, because it would be useful if our community could align around a preferred way of referring to these files. That would be useful for:
If a consensus emerges, we could document that in the spec itself (probably as a non-normative suggestion, but I think that could still be useful).
So, please share your names and let's discuss. Thanks! ❤️
The text was updated successfully, but these errors were encountered: