ソースを参照

Minor documentation changes

crobi 10年前
コミット
fe8aeb4b91
1個のファイルの変更17行の追加19行の削除
  1. 17
    19
      index.html

+ 17
- 19
index.html ファイルの表示

@@ -81,7 +81,8 @@
81 81
 </h3>
82 82
 
83 83
 <p>
84
-    <a href="generator/generate.html">Try it out yourself</a>. Press "Load sample cards" in the menu, then press "Generate cards".
84
+    <a href="generator/generate.html">Try it out yourself</a>.
85
+    Press "Load sample" in the menu, then press "Generate" and have a look at the newly opened window/tab that contains all the generated cards.
85 86
 </p>
86 87
 
87 88
 <h2>Documentation</h2>
@@ -96,31 +97,31 @@ This is not a complete documentation, but some information that should help you
96 97
 <p>
97 98
     <ul>
98 99
         <li>
99
-            <strong>count</strong>
100
+            <code>count</code>
100 101
             The number of times this card is repeated. Useful for consumable items that you hand out multiple times.
101 102
         </li>
102 103
         <li>
103
-            <strong>color</strong>
104
+            <code>color</code>
104 105
             Name of the card color. You can use all <a href="http://www.w3schools.com/cssref/css_colornames.asp">CSS color names</a>.
105 106
             Additional custom colors are defined in <code>css/custom-colors.css</code>.
106 107
         </li>
107 108
         <li>
108
-            <strong>icon</strong>
109
+            <code>icon</code>
109 110
             Name of the card icon. You can use all icons from <a href="http://game-icons.net/">game-icons.net</a>.
110 111
             For example, the file name of <a href="http://game-icons.net/lorc/originals/plain-dagger.html">this dagger</a>
111 112
             is "plain-dagger.png", so you would use "plain-dagger" as the icon name.
112 113
             Additional custom icon names are defined in <code>css/custom-icons.css</code>.
113 114
         </li>
114 115
         <li>
115
-            <strong>back_icon</strong>
116
+            <code>icon_back</code>
116 117
             Optional. Name of the big icon on the card back. If not specified, the icon from the "icon" property is used.
117 118
         </li>
118 119
         <li>
119
-            <strong>title</strong>
120
+            <code>title</code>
120 121
             The title of the card.
121 122
         </li>
122 123
         <li>
123
-            <strong>contents</strong>
124
+            <code>contents</code>
124 125
             An array of strings, specifying all card elements, in top to bottom order (see below).
125 126
         </li>
126 127
     </ul>
@@ -140,42 +141,39 @@ This is not a complete documentation, but some information that should help you
140 141
 
141 142
     <ul>
142 143
         <li>
143
-            <strong>subtitle</strong>
144
+            <code>subtitle</code>
144 145
             Slightly larger italic text.
145 146
             Param1: the subtitle text.
146 147
         </li>
147 148
         <li>
148
-            <strong>rule</strong>
149
+            <code>rule</code>
149 150
             A horizontal rule.
150 151
         </li>
151 152
         <li>
152
-            <strong>property</strong>
153
+            <code>property</code>
153 154
             A property line. The property description is indented if it spans more than one line.
154 155
             Param1: the property name (in bold).
155 156
             Param2: the property description.
156 157
         </li>
157 158
         <li>
158
-            <strong>description</strong>
159
+            <code>description</code>
159 160
             Same as <i>property</i>, but text is not indented.
160 161
         </li>
161 162
         <li>
162
-            <strong>text</strong>
163
+            <code>text</code>
163 164
             A simple paragraph of text.
164 165
             Param1: the text.
165 166
         </li>
166 167
         <li>
167
-            <strong>subsection</strong>
168
+            <code>subsection</code>
168 169
             A subsection header, with a horizontal rule below the subsection name.
169 170
             Param1: the subsection name
170 171
         </li>
171 172
         <li>
172
-            <strong>fill-1</strong>
173
-            A dynamically resized empty element that takes up 1 unit of unused space on the card.
173
+            <code>fill</code>
174
+            A dynamically resized empty element that takes up a portion of unused space on the card.
174 175
             You can use this to vertically center text by adding one of these before and after the text you want to center.
175
-        </li>
176
-        <li>
177
-            <strong>fill-2</strong>
178
-            Same as <i>fill-1</i>, but takes up 2 units of unused space - these elements will therefore be larger than any <i>fill-1</i> element.
176
+            Param1: the number of units of empty space to use.
179 177
         </li>
180 178
     </ul>
181 179
 </p>

読み込み中…
キャンセル
保存