[MTE-31] Dialog filenames should not use ".dialog" Created: 02/Jun/15 Updated: 24/Jun/15 Resolved: 23/Jun/15 |
|
| Status: | Closed |
| Project: | Magnolia Templating Essentials |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 0.5 |
| Type: | Improvement | Priority: | Neutral |
| Reporter: | Christopher Zimmermann | Assignee: | Espen Jervidalo |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Template: |
|
||||||||
| Acceptance criteria: |
Empty
|
||||||||
| Task DoD: |
[ ]*
Doc/release notes changes? Comment present?
[ ]*
Downstream builds green?
[ ]*
Solution information and context easily available?
[ ]*
Tests
[ ]*
FixVersion filled and not yet released
[ ] 
Architecture Decision Record (ADR)
|
||||||||
| Date of First Response: | |||||||||
| Description |
|
The convention should be The dot is especially confusing because one references a dialog by its name - not its filename. For the reasons presented in the comments - the dialog file name should be the same name as the template name - just in a different directory. |
| Comments |
| Comment by Philip Mundt [ 02/Jun/15 ] |
|
I would vote against this pattern:
I would actually get rid of the .dialog. |
| Comment by Christian Ringele [ 02/Jun/15 ] |
|
I agree on ph's comment. I would vote against bith patterns: As the path alrady indicates what it is. Also think about the id of a dialog you set in the template def: Usually you want to copy paste: |
| Comment by Christopher Zimmermann [ 03/Jun/15 ] |
|
Thanks for your comments, I find them all reasonable and compelling.
|
| Comment by Christian Ringele [ 03/Jun/15 ] |
|
I see the downsides you describe, but I think they don't make up for the other downsides. The content of the files is quite different, I think with a little bit of practice people see fast if its a template def or a dialog def. But the downsides of having redundancy in the file names stays for the whole project /use of Magnolia, no matter how experienced you are. And also: And you would be surprised how they are still confused what to do where. |