Updated documentation to match API 0.7.2

[projects/chimara/chimara.git] / docs / reference / glk-display-style.sgml

diff --git a/docs/reference/glk-display-style.sgml b/docs/reference/glk-display-style.sgml
index d119c24636d135e68648f3aed361dfe399a0ec76..110af535639f2a145ad6b824db215960953dd4a5 100644 (file)
--- a/docs/reference/glk-display-style.sgml
+++ b/docs/reference/glk-display-style.sgml
@@ -15,13 +15,17 @@
 <refsect1>
 <title>Description</title>
 <para>
-The way windows are displayed is, of course, entirely up to the Glk library; it depends on what is natural for the player's machine. The borders between windows may be black lines, 3-D bars, rows of <quote><computeroutput>&num;</computeroutput></quote> characters; there may even be no borders at all. 
+The way windows are displayed is, of course, entirely up to the Glk library; it depends on what is natural for the player's machine. The borders between windows may be black lines, 3-D bars, rows of <quote><computeroutput>&num;</computeroutput></quote> characters; there may even be no borders at all.
+The library may not support the Border/NoBorder hint, in which case <emphasis>every</emphasis> pair of windows will have a visible border &mdash; or no border &mdash; between them.
 </para>
 <note><para>
-This is an important possibility to keep in mind.
+The Border/NoBorder was introduced in Glk 0.7.1.
+Prior to that, all games used the Border hint, and this remains the default.
+However, as noted, not all implementations display window borders.
+Therefore, for existing implementations, <quote>Border</quote> may be understood as <quote>your normal style of window display</quote>; <quote>NoBorder</quote> may be understood as <quote>suppress any interwindow borders you may have</quote>.
 </para></note>
 <para>
-There may be other decorations as well. A text buffer window will often have a scroll bar. The library (or player) may prefer wide margins around each text window. And so on.
+There may be decorations within the windows as well. A text buffer window will often have a scroll bar. The library (or player) may prefer wide margins around each text window. And so on.
 </para>
 <para>
 The library is reponsible for handling these decorations, margins, spaces, and borders. You should never worry about them. You are guaranteed that if you request a fixed size of two rows, your text grid window will have room for two rows of characters &mdash; if there is enough total space. Any margins or borders will be allowed for already. If there <emphasis>isn't</emphasis> enough total space (as in stages 4 and 5 of <link linkend="chimara-Figure-Squeezing-Window">this figure</link>), you lose, of course.