search

tajmone / PBCodeArcProto

PB CodeArchiv Rebirth Indexer Prototype
4 stars 0 forks source link

Keys With Empty Values #9

Open tajmone opened 6 years ago

tajmone commented 6 years ago

I've noticed that header comments contain many keys with no actual values. Example:

;: English-Forum: http://www.purebasic.fr/english/viewtopic.php?p=425502#p425502
;:  French-Forum: 
;:  German-Forum:

All resources contain the three PB forums keys (EN, FR, DE) even if no links are available for some (or all) of them. I guess that this is a sort of templating format for the console app which you mentioned you where planning to create.

My question is: Should keys with empty values be preserved in the final HTML resume cards, or can we omit them?

Changing the comments parser to ignore such keys is not a problem, since all key:value pairs are handled as individual entries in Lists.

SicroAtGit commented 6 years ago

All resources contain the three PB forums keys (EN, FR, DE) even if no links are available for some (or all) of them. I guess that this is a sort of templating format for the console app which you mentioned you where planning to create.

I decided that the code header should always look the same, so that you can always see what information a new code should have. Entries without content can be later filled with content without having to find out what the entry name must be. The format of the code header is strictly always the same (character by character, including the whitespaces). I chose this strict formatting because it was planned from the beginning to be able to simply parse the code header later. I already foresaw a more simple and clear possibility to navigate through the archive, but at that time I didn't think about it anymore (website or something else). Thanks to your help, there will be this option in the near future.

The dev tools mentioned in another issue already existed in an earlier version of the repository, but when I recently rebuilt the repository history (), I didn't add the tools again. I'll do that later. On this fork the dev tools are still present: Link The reasons can be read in the corresponding forum thread: Link

My question is: Should keys with empty values be preserved in the final HTML resume cards, or can we omit them?

Yes, in the resume cards we can omit the empty entries, I think.

SicroAtGit commented 6 years ago

Another code header entry has been added to the IDE tool codes: "Parameter" I think I will add this entry to the other code headers as well, so that the code header is the same again everywhere.

tajmone commented 6 years ago

The dev tools mentioned in another issue already existed in an earlier version of the repository, but when I recently rebuilt the repository history (**), I didn't add the tools again.

I did notice that a number of files (especially tools for contributors) had dissapeared when I pulled from the mainstream repo. But I agree with what you posted on the forum, in such cases rewriting history is legit and doesn't really pose a problem (is not an API on which other projects depend on).