search

iftechfoundation / ifarchive-ifmap-py

The tool that generates the index files at http://ifarchive.org/ .
3 stars 1 forks source link

Include deep-link descriptions in Master-Index.xml #41

Closed erkyrath closed 1 month ago

erkyrath commented 2 months ago

E.g., an Index file might have a stanza

# old/older

A double-depth entry.

Currently this description doesn't make it into the XML entry for old/older. Only the description in the parent directory (old) does.

We could sneak it in, perhaps with the format

<altindex>
  <directory>if-archive/games</directory>
  <description>
    A double-depth entry.
  </description>
</altindex >

A file/directory would have (at most) one <description>, but perhaps also one or more <altindex> tags containing additional descriptions.

Maybe that's too fancy and it should just be

<description dir="if-archive/games">
  A double-depth entry.
</description>
erkyrath commented 2 months ago

I suppose we want to pull in metadata from the alt entries, as well. That can be merged in (uniquified).

erkyrath commented 1 month ago

Dan F requests this be done by the time IFComp 2024 wraps up.

erkyrath commented 1 month ago

I think this is all working now. I wound up using the format

<parentdesc dir="if-archive/games">
Description defined in the /games directory.
</parentdesc>

There could be more than one <parentdesc> stanza for a file (or directory), but I can't think of a reason why we'd do that, and in fact there are no current examples.