Drasil: Populate Source Fields

[samm82]

As mentioned in #424, the Source fields need to be populated with citations in the examples.

TODO

• [x] HGHC (Probably doesn't need them, but I'll double check)
• [x] GlassBR
• [x] NoPCM
  
  
  
  • [x] TMs
  
  
  • [x] GDs
  
  
• [x] SWHS
  
  
  
  • [x] TMS
  
  
  • [x] GDs
  
  
• [x] SSP
  
  
  
  • [x] GD7
  
  
• [x] GamePhysics

[samm82]

@JacquesCarette @szymczdm I'm not super familiar with the Label infrastructure - how would we add a reference to a webpage? In the T2 of NoPCM (in caseStudies), the Source field is a Wikipedia page. If it were a reference in the References section, the Source field of the TM would just be [makeRef citationName]. How would I replicate that with a webpage link?

[samm82]

Also, the Source, Description and Ref. By fields are missing in GD7 of SSP - should I assume that the Source is the same as GD8, and what should be done about the other two fields? A new issue? @smiths

[samm82]

Also @smiths, in caseStudies, the Source fields for GamePhysics are completely empty. Should this be a separate issue as well?

[JacquesCarette]

I think it is safe to assume the Source and Ref. By for GD7 are the same as for GD8.

[samm82]

Then should I reference GD7 in the description of GD8, and add a description ("See GD8") to GD7?

[JacquesCarette]

We do allow labels to be URLs. I don't quite remember the details of how to do that -- you might need to read the Haskell source. It should at least be possible to create it. Then try makeRef and see what happens.

[JacquesCarette]

No, because GD7 doesn't depend on GD8. You should 'reference' the same Source. And does DD17 and IM4 reference GD7?

It is weird that GD7 have no description.

[samm82]

DD17 doesn't reference either of them:

And IM4 doesn't explicitly reference either of them, but it uses both of their equations:

---

And what I meant about referencing GD7 - the description of GD8 says "These equations...", but only one equation is defined, so I'm assuming the same description applies to GD7 (x-component) and GD8 (y-component), so this connection should be captured in the description of GD7.

In Drasil, the description of both of these GDs have the standard list of quantities used, but the Notes of GD8 contain the Description from caseStudies, but I think it should still reference GD7.

[JacquesCarette]

I probably have things backwards as far as referencing.

Also, I get this feeling that GD7 and GD8 should be a single definition, not two. [This may not currently be possible.]

[samm82]

It currently isn't possible to have two equations defined in a DD - what should the fix be for now?

[JacquesCarette]

Try to make both be as similar as possible.

[samm82]

@JacquesCarette What should the shortname be for a URI link? Should it be the full web address or should it be abbreviated (ie. "http://www.efunda.com/formulae/heat_transfer/conduction/overview_cond.cfm" vs. "www.efunda.com")

[samm82]

@JacquesCarette And an update - Clicking on one of these links created with makeRef just appends the URI to the end of the current file path (eg. pathToSRS.html#www.full.com/web/address)

EDIT: I just had to define another function in drasil-printers (see f036f72)

[JacquesCarette]

If at all possible, the shortname for a URI link should be 'meaningful' (because it is supposed to be seen by humans) rather than URL-like. Something closer to the title of the page being linked to, rather than something like the URL.

[samm82]

I'm going to create a separate issue for GamePhysics, and then this issue can be closed. Who should I assign the issue to? @JacquesCarette

[JacquesCarette]

Right now, no one. @smiths and I will need to review all of those in early September and figure out what to do with them.

[samm82]

1005