Proposal: refactor "static-elements" system #1345

New Issue

reinhard · 2020-04-30T14:55:25Z

reinhard commented

2020-04-30 14:55:25 +00:00

I propose a few changes to the current "static-elements" concept:

Move the xml files into global/feeds/<somename>/, they don't really fit in the "tools" directory.
Generally feed these xml files into all pages without the need of a .sources file. Needs changes in the Phase-2 Makefile dependency check and in scaffold.sh.
For a video which is included in the page as dynamically as it can get in our build system, I consider "static-elements" a confusing term. So: maybe we can try to come up with a better name :-)

I propose a few changes to the current "static-elements" concept: 1. Move the xml files into `global/feeds/<somename>/`, they don't really fit in the "tools" directory. 2. Generally feed these xml files into all pages without the need of a .sources file. Needs changes in the Phase-2 Makefile dependency check and in `scaffold.sh`. 3. For a video which is included in the page as dynamically as it can get in our build system, I consider "static-elements" a confusing term. So: maybe we can try to come up with a better name :-)

reinhard added a new dependency 2020-04-30 14:56:14 +00:00

#1337 Make news/donate boxes on index static elements

max.mehl commented

2020-05-04 11:47:38 +00:00

Full ack on the general idea!

Why did you propose feeds as a directory name? For me this rather is RSS ;)
Regarding the name, what about flex-elements or variable-elements? This also may be confusion because initially the name static derived from the option that you only have to add <static-element id="video" /> once for all languages statically, but can edit the content dynamically in the included file itself. But well, that's nitpicking, and I am open for a better term ;)

Full ack on the general idea! * Why did you propose `feeds` as a directory name? For me this rather is RSS ;) * Regarding the name, what about `flex-elements` or `variable-elements`? This also may be confusion because initially the name `static` derived from the option that you only have to add `<static-element id="video" />` once for all languages statically, but can edit the content dynamically in the included file itself. But well, that's nitpicking, and I am open for a better term ;)

reinhard commented

2020-05-04 12:52:55 +00:00

"feeds" is the best term I could come up to describe those XML files from which data is fed into the actual pages. If you have a better name, please speak up :-). In any case, I consider "xmlfiles" or something like that to not be suitable, because there are so many other xml files in our system.

Regarding the name for the stuff, I'd love something that sounds like "pre-built module or building block that you can insert everywhere", but I can't come up with a word right now...

"feeds" is the best term I could come up to describe those XML files from which data is fed into the actual pages. If you have a better name, please speak up :-). In any case, I consider "xmlfiles" or something like that to not be suitable, because there are so many other xml files in our system. Regarding the name for the stuff, I'd love something that sounds like "pre-built module or building block that you can insert everywhere", but I can't come up with a word right now...

max.mehl commented

2020-05-05 15:30:03 +00:00

What about "modules"? We can use /global/modules/ as directory, and <module id="video" /> as a tag.

What about "modules"? We can use `/global/modules/` as directory, and `<module id="video" />` as a tag.

reinhard commented

2020-05-05 16:09:06 +00:00

Yes, I think "module" is an excellent term for what this stuff actually is!

reinhard added the

xsl

build

labels 2020-05-06 18:19:04 +00:00

reinhard added a new dependency 2020-05-06 18:21:49 +00:00