Skip to content

Commit c8e42e3

Browse files
scottgonzalezscottgonzalez
committed
Update XSL to match UI.
1 parent e1becca commit c8e42e3

File tree

1 file changed

+131
-27
lines changed

1 file changed

+131
-27
lines changed

‎entries2html-base.xsl

Lines changed: 131 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040
<xsl:variable name="entry-pos" select="concat($entry-name-trans,$entry-index)"/>
4141
<xsl:variable name="number-examples" select="count(example)"/>
4242

43-
<xsl:if test="./added">
44-
<span class="versionAdded">version added: <xsl:value-of select="added"/></span>
43+
<xsl:if test="$entry-type='widget'">
44+
<xsl:call-template name="widget-quick-nav"/>
4545
</xsl:if>
4646

4747
<article>
@@ -186,6 +186,9 @@
186186
<span><xsl:value-of select="title"/></span>
187187
</xsl:otherwise>
188188
</xsl:choose>
189+
<xsl:if test="./added">
190+
<span class="versionAdded">version added: <xsl:value-of select="added"/></span>
191+
</xsl:if>
189192
</h2>
190193
</xsl:template>
191194

@@ -204,6 +207,9 @@
204207
<xsl:when test="@type='widget'">
205208
<xsl:call-template name="entry-body-widget"/>
206209
</xsl:when>
210+
<xsl:when test="@type='effect'">
211+
<xsl:call-template name="entry-body-effect"/>
212+
</xsl:when>
207213
</xsl:choose>
208214
</xsl:template>
209215

@@ -246,6 +252,12 @@
246252
</xsl:if>
247253
<xsl:value-of select="@name"/>
248254
</h4>
255+
256+
<xsl:if test="properties">
257+
<ul><xsl:for-each select="properties/property">
258+
<xsl:apply-templates select="."/>
259+
</xsl:for-each></ul>
260+
</xsl:if>
249261
</li>
250262
</ul>
251263
</xsl:template>
@@ -297,14 +309,21 @@
297309
<xsl:for-each select="options/option">
298310
<xsl:sort select="@name"/>
299311
<div id="option-{@name}">
312+
<xsl:attribute name="class">
313+
<xsl:text>api-item</xsl:text>
314+
<xsl:if test="position() = 1">
315+
<xsl:text> first-item</xsl:text>
316+
</xsl:if>
317+
</xsl:attribute>
318+
300319
<h3>
301320
<xsl:value-of select="@name"/>
321+
<span class="option-type">
322+
<strong>Type: </strong>
323+
<xsl:call-template name="render-types"/>
324+
</span>
302325
</h3>
303-
<div>
304-
<strong>Type: </strong>
305-
<xsl:call-template name="render-types"/>
306-
</div>
307-
<div>
326+
<div class="default">
308327
<strong>Default: </strong>
309328
<code><xsl:value-of select="@default"/></code>
310329
</div>
@@ -341,12 +360,23 @@
341360
<xsl:for-each select="methods/method">
342361
<xsl:sort select="@name"/>
343362
<xsl:variable name="method-name" select="@name"/>
363+
<xsl:variable name="method-position" select="position()"/>
344364
<div id="method-{$method-name}">
365+
345366
<xsl:for-each select="signature | self::node()[count(signature) = 0]">
346-
<xsl:call-template name="widget-method-event">
347-
<xsl:with-param name="entry-name" select="$entry-name"/>
348-
<xsl:with-param name="method-name" select="$method-name"/>
349-
</xsl:call-template>
367+
<div>
368+
<xsl:attribute name="class">
369+
<xsl:text>api-item</xsl:text>
370+
<xsl:if test="$method-position = 1 and position() = 1">
371+
<xsl:text> first-item</xsl:text>
372+
</xsl:if>
373+
</xsl:attribute>
374+
375+
<xsl:call-template name="widget-method-event">
376+
<xsl:with-param name="entry-name" select="$entry-name"/>
377+
<xsl:with-param name="method-name" select="$method-name"/>
378+
</xsl:call-template>
379+
</div>
350380
</xsl:for-each>
351381
</div>
352382
</xsl:for-each>
@@ -360,6 +390,13 @@
360390
<xsl:for-each select="events/event">
361391
<xsl:sort select="@name"/>
362392
<div id="event-{@name}">
393+
<xsl:attribute name="class">
394+
<xsl:text>api-item</xsl:text>
395+
<xsl:if test="position() = 1">
396+
<xsl:text> first-item</xsl:text>
397+
</xsl:if>
398+
</xsl:attribute>
399+
363400
<xsl:call-template name="widget-method-event">
364401
<xsl:with-param name="entry-name" select="$entry-name"/>
365402
<xsl:with-param name="method-name" select="@name"/>
@@ -370,6 +407,62 @@
370407
</xsl:if>
371408
</xsl:template>
372409

410+
<xsl:template name="entry-body-effect">
411+
<ul class="signatures">
412+
<li class="signature">
413+
<h4 class="name">
414+
<xsl:if test="signature/added">
415+
<span class="versionAdded">
416+
version added:
417+
<a href="/category/version/{signature/added}/">
418+
<xsl:value-of select="added"/>
419+
</a>
420+
</span>
421+
</xsl:if>
422+
<xsl:value-of select="@name"/>
423+
</h4>
424+
425+
<xsl:if test="arguments">
426+
<ul><xsl:for-each select="arguments/argument">
427+
<xsl:apply-templates select="."/>
428+
</xsl:for-each></ul>
429+
</xsl:if>
430+
</li>
431+
</ul>
432+
</xsl:template>
433+
434+
<xsl:template name="widget-quick-nav">
435+
<section class="quick-nav">
436+
<header>
437+
<h2>QuickNav</h2>
438+
</header>
439+
440+
<div class="quick-nav-section">
441+
<h3>Options</h3>
442+
<xsl:for-each select="options/option">
443+
<xsl:variable name="name" select="@name"/>
444+
<div><a href="#option-{$name}"><xsl:value-of select="$name"/></a></div>
445+
</xsl:for-each>
446+
</div>
447+
448+
<div class="quick-nav-section">
449+
<h3>Methods</h3>
450+
<xsl:for-each select="methods/method">
451+
<xsl:variable name="name" select="@name"/>
452+
<div><a href="#method-{$name}"><xsl:value-of select="$name"/></a></div>
453+
</xsl:for-each>
454+
</div>
455+
456+
<div class="quick-nav-section">
457+
<h3>Events</h3>
458+
<xsl:for-each select="events/event">
459+
<xsl:variable name="name" select="@name"/>
460+
<div><a href="#event-{$name}"><xsl:value-of select="$name"/></a></div>
461+
</xsl:for-each>
462+
</div>
463+
</section>
464+
</xsl:template>
465+
373466
<!-- examples -->
374467
<xsl:template match="example">
375468
<xsl:param name="entry-index"/>
@@ -387,7 +480,7 @@
387480

388481
<h4>
389482
<xsl:if test="$number-examples &gt; 1">Example: </xsl:if>
390-
<span class="desc"><xsl:value-of select="desc"/></span>
483+
<span class="desc"><xsl:apply-templates select="desc"/></span>
391484
</h4>
392485
<pre><code data-linenum="true">
393486
<xsl:choose>
@@ -440,7 +533,9 @@
440533
<!-- elements. Render each type, comma seperated -->
441534
<xsl:if test="type">
442535
<xsl:for-each select="type">
443-
<xsl:if test="position() &gt; 1">, </xsl:if>
536+
<xsl:if test="position() &gt; 1">
537+
<xsl:text> or </xsl:text>
538+
</xsl:if>
444539
<xsl:call-template name="render-type">
445540
<xsl:with-param name="typename" select="@name" />
446541
</xsl:call-template>
@@ -460,18 +555,7 @@
460555
-->
461556
<xsl:when test="$typename = 'Function'">
462557
<a href="http://api.jquery.com/Types/#Function">Function</a>
463-
<xsl:text>(</xsl:text>
464-
<xsl:if test="argument">
465-
<xsl:text> </xsl:text>
466-
<xsl:for-each select="argument">
467-
<xsl:if test="position() &gt; 1">, </xsl:if>
468-
<xsl:value-of select="@name"/>
469-
<xsl:text>: </xsl:text>
470-
<xsl:call-template name="render-types"/>
471-
</xsl:for-each>
472-
<xsl:text> </xsl:text>
473-
</xsl:if>
474-
<xsl:text>)</xsl:text>
558+
<xsl:call-template name="render-type-function"/>
475559

476560
<!-- display return type if present -->
477561
<xsl:if test="return or @return">
@@ -486,6 +570,26 @@
486570
</xsl:choose>
487571
</xsl:template>
488572

573+
<xsl:template name="render-type-function">
574+
<xsl:text>(</xsl:text>
575+
<xsl:if test="argument">
576+
<xsl:text> </xsl:text>
577+
<xsl:for-each select="argument">
578+
<xsl:if test="position() &gt; 1">, </xsl:if>
579+
<a href="http://api.jquery.com/Types#{@type}">
580+
<xsl:value-of select="@type"/>
581+
</a>
582+
<xsl:text> </xsl:text>
583+
<xsl:value-of select="@name"/>
584+
<xsl:if test="@type = 'Function'">
585+
<xsl:call-template name="render-type-function"/>
586+
</xsl:if>
587+
</xsl:for-each>
588+
<xsl:text> </xsl:text>
589+
</xsl:if>
590+
<xsl:text>)</xsl:text>
591+
</xsl:template>
592+
489593
<xsl:template name="render-return-types">
490594
<xsl:if test="@return and return">
491595
<strong>ERROR: Use <i>either</i> @return or return element</strong>
@@ -494,7 +598,7 @@
494598
<!-- return attribute -->
495599
<xsl:if test="@return">
496600
<xsl:call-template name="render-type">
497-
<xsl:with-param name="typename" select="@return" />
601+
<xsl:with-param name="typename" select="@return"/>
498602
</xsl:call-template>
499603
</xsl:if>
500604

@@ -504,7 +608,7 @@
504608
<xsl:if test="position() &gt; 1">
505609
<strong>ERROR: A single return element is expected</strong>
506610
</xsl:if>
507-
<xsl:call-template name="render-types" />
611+
<xsl:call-template name="render-types"/>
508612
</xsl:for-each>
509613
</xsl:if>
510614
</xsl:template>

0 commit comments

Comments
 (0)