Cleaning up Citation Prompts

[benloh]

@jdanish @kalanicraig As part of the import / export feature and template development, we probably need to clean up the data structures as well. Otherwise the whole thing becomes too Rube Goldbergy.

One specific area I want to make sure I understand is the citationPrompts. This is just a field in the template that defines the string to use when citing a node or edge presumably for a paper or classroom discussion? Is it used for anything else?

For the template, then, it probably ought to be renamed citation and citation.label and citation.hidden?

(nodePrompts was more of a historical artifact that emerged from the original template goal of simply defining the labeling for nodes. The template has evolved into much more than simply defining prompts, so we probably want to consider changing it to something like nodeDefinitions).

---

One additional note here: citationPrompts is easily confused with Edge's Citations. I wonder if we need to come up with a better disambiguation of the user-entered citation info (e.g. source of information) from the system-generated citation (e.g. bibilographic label).

[jdanish]

Hey Ben,

I am attaching a screen capture of where this is displayed if it is not hidden. But, yes, the idea is that students can then copy this into a paper in class, or similar.

I think I called it citationPrompts to mirror nodePrompts and edgePrompts, so no need to stick with that. And agreed, citation.label makes the most sense moving forward.

Joshua

On Jan 17, 2022, at 6:29 PM, benloh @.***> wrote:

@jdanish https://github.com/jdanish @kalanicraig https://github.com/kalanicraig As part of the import / export feature and template development, we probably need to clean up the data structures as well. Otherwise the whole thing becomes too Rube Goldbergy.

One specific area I want to make sure I understand is the citationPrompts. This is just a field in the template that defines the string to use when citing a node or edge presumably for a paper or classroom discussion? Is it used for anything else?

For the template, then, it probably ought to be renamed citation and citation.label and citation.hidden?

(nodePrompts was more of a historical artifact that emerged from the original template goal of simply defining the labeling for nodes. The template has evolved into much more than simply defining prompts, so we probably want to consider changing it to something like nodeDefinitions).

— Reply to this email directly, view it on GitHub https://github.com/netcreateorg/netcreate-2018/issues/189, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABKGCKWBKSVJE66QL4MVRRLUWSQ33ANCNFSM5MFY6OBA. Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you were mentioned.

[netcreateorg]

[benloh]

Thanks! Given the changes all around, we may end up completely revamping the template format. The potential issue is that this might result in a major version change with backward incompatibility. e.g. you'd have to back and fix any existing data sets and templates that you're using. How much of an existing base of data and templates do you have?

[netcreateorg]

On my end, not that much and easily fixed if I know the new format. Kalani?

[kalanicraig]

We have lots of templates but as long as we have a clear set of guidelines for new vs old data and templates, I’d rather we have a good set of files and formats now that support imports than a guarantee of backward compatibility.

On Mon, Jan 17, 2022 at 7:15 PM Net.Create @.***> wrote:

On my end, not that much and easily fixed if I know the new format. Kalani?

— Reply to this email directly, view it on GitHub https://github.com/netcreateorg/netcreate-2018/issues/189#issuecomment-1014967561, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACKL4NFZ6OSJ4IKVEVDBVRLUWSWIVANCNFSM5MFY6OBA . You are receiving this because you were mentioned.Message ID: @.***>

[benloh]

Implemented.