Skip to content
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

Attributes in separate TSV file #578

Open
lhmarsden opened this issue Dec 17, 2024 · 1 comment
Open

Attributes in separate TSV file #578

lhmarsden opened this issue Dec 17, 2024 · 1 comment
Labels
enhancement Proposals to add new capabilities, improve existing ones in the conventions, improve style or format

Comments

@lhmarsden
Copy link

It would be good if the attributes listed here https://github.com/cf-convention/cf-conventions/blob/main/appa.adoc were sourced from a standalone file that is easier to read and develop software upon.

See this discussion for previous conversation on this
https://github.com/orgs/cf-convention/discussions/384

I will work on this and submit a pull request.

@lhmarsden lhmarsden added the enhancement Proposals to add new capabilities, improve existing ones in the conventions, improve style or format label Dec 17, 2024
@lhmarsden
Copy link
Author

I have been trying to work on this all day. Creating the TSV or CSV file is easy. However, presenting it nicely is not.

Referring to this file:
https://github.com/cf-convention/cf-conventions/blob/main/appa.adoc

I think I know what the issue is. This code snippet:

[[table-attributes]]
.Attributes
[options="header",cols="6,2,2,8,12",caption="Table A.1. "]
|===============
|{set:cellbgcolor!}
Attribute
| Type
| Use
| Links
| Description

Each cell in the table is separated by a '|'. The first cell is

|{set:cellbgcolor!}
Attribute

If you remove this {set:cellbgcolor!} the table for some reason has a red background. I assume this was put in as a quick fix. Ideally this would be somewhere else (perhaps in the config file). I don't know why the background is red by default. Nevertheless, the solution of including this within the first cell works with the current setup. However, if I do something like this:

[[table-attributes]]
.Attributes
[options="header",separator=|,cols="6,2,2,8,12",caption="Table A.1."]
[%header,format=csv]
|==============
{set:cellbgcolor!}
include::attributes.csv[]
|==============

This {set:cellbgcolor!} is seen as a separate cell. So then Attributes is moved along to the second column and every other cell thereafter is also moved along by one position.

I have tried a number of different things

  • Different delimiters
  • Including {set:cellbgcolor!} in the CSV file
  • TSV file instead of CSV

but with no luck.

Does anyone know the origin of this {set:cellbgcolor!} code and whether this can be done in a different way? Perhaps someone is more familiar with how the makefile and config file are working. Why is the table being created with a red background if we remove this line?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Proposals to add new capabilities, improve existing ones in the conventions, improve style or format
Projects
None yet
Development

No branches or pull requests

1 participant