Jump to content


Photo

Issue #23 when to use the different styled notes?


5 replies to this topic

#1 Calhavintas

Calhavintas

    Chaotic Good Mage

  • Members
  • 19 posts
  • Gender:Male
  • Location:Northern Germany

Posted 10 August 2017 - 05:32 AM

Hi there,

 

the issue #23 on github mentions the use of the styled notes (note, warning, info, success, important), but doesn't explain under which circumstances they should by applied.

 

Warning may be the easiest: if some error or crash appears in-game.

 

The meaning of the others are a little bit blurry to me ???



#2 lynx

lynx
  • Modders
  • 3031 posts
  • Gender:Male
  • Location:Ljubljana, Slovenija

Posted 10 August 2017 - 05:44 AM

It's completely debatable where and when they should be used. I think so far only note and warning are used.


GemRB - IE anywhere.
Mages needed! Looking for Planescape: Torment testers
Market android version IS NOT SUPPORTED ANYMORE: reported bugs will be ignored! Still looking for builders ...

#3 Calhavintas

Calhavintas

    Chaotic Good Mage

  • Members
  • 19 posts
  • Gender:Male
  • Location:Northern Germany

Posted 10 August 2017 - 05:49 AM

Then i would stick with these two for the moment, unless it's clear from the description, that they don't match well.

 

Regarding this code snippet (found in op001.html)

{{site.game}}

should this be included in the note or removed or placed elsewhere?

 

UPDATE:

is this the correct notation for multiple notes:

{% capture note %}
First Note
{% endcapture %}

{% include note.html %}

{% capture note %}
First warning
{% endcapture %}

{% include warning.html %}

{% capture note %}
Second Note
{% endcapture %}

{% include note.html %}

?


Edited by Calhavintas, 10 August 2017 - 06:10 AM.


#4 lynx

lynx
  • Modders
  • 3031 posts
  • Gender:Male
  • Location:Ljubljana, Slovenija

Posted 10 August 2017 - 06:17 AM

That particular one looks extraneus and is evaluated to an empty string anyway.

 

Notes: yes. Even if two notes of the same type follow each other (and it makes sense not to merge them), you need two includes.


Edited by lynx, 10 August 2017 - 06:18 AM.

GemRB - IE anywhere.
Mages needed! Looking for Planescape: Torment testers
Market android version IS NOT SUPPORTED ANYMORE: reported bugs will be ignored! Still looking for builders ...

#5 Calhavintas

Calhavintas

    Chaotic Good Mage

  • Members
  • 19 posts
  • Gender:Male
  • Location:Northern Germany

Posted 10 August 2017 - 06:28 AM

Ok, thanks for the answers :)



#6 Calhavintas

Calhavintas

    Chaotic Good Mage

  • Members
  • 19 posts
  • Gender:Male
  • Location:Northern Germany

Posted 10 August 2017 - 08:09 AM

All opcodes should have styled notes :)


Edited by Calhavintas, 10 August 2017 - 01:19 PM.




Reply to this topic



  


0 user(s) are reading this topic

0 members, 0 guests, 0 anonymous users