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

Glossary part of openETCS document template? #4

Open
BerndHekele opened this issue Sep 24, 2013 · 4 comments
Open

Glossary part of openETCS document template? #4

BerndHekele opened this issue Sep 24, 2013 · 4 comments
Assignees

Comments

@BerndHekele
Copy link
Member

Dear Jan,
if we are now proposing the glossary for our documents in the QA-plan, don't we need to update the template as well?

@ghost ghost assigned janWelte Sep 24, 2013
@janWelte
Copy link
Collaborator

Dear Bernd,

you are right. But I wanted to wait with a concrete proposal until Izaskun gives me a feedback about the use.
The problem is that just changing the template is not enough, since this interactive glossary is only helpful if people reference glossary terms in their document.

What do you think. Shall we change the template or shall we wait until all supporting documents are finished?

@BerndHekele
Copy link
Member Author

In the meantime I had a talk to Peter.
He did not like the idea too much.
His preference was to only load it when you use it.
Lets get more opinions before we change the template.

@janWelte
Copy link
Collaborator

I've to admit that this sounds reasonable. Especially under the circumstances that you have to actively use the glossary to include any term in the document.

@BerndHekele
Copy link
Member Author

Maybe we can use some comments to switch on and off.
Do you have an example file where the glossary is used which is not too big to get lost inside?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants