Revert "Revert "Merge pull #793: Dev Docs: New Glossary & JS Search Box""

This reverts commit 961d6c988f.
This commit is contained in:
David A. Harding 2015-04-14 08:06:08 -04:00
parent ceaf266040
commit a2a5f454cb
No known key found for this signature in database
GPG key ID: 4B29C30FF29EC4B7
126 changed files with 3827 additions and 470 deletions

View file

@ -7,15 +7,19 @@ lang: en
id: developer-documentation
title: "Developer Documentation - Bitcoin"
---
<link rel="stylesheet" href="/css/jquery-ui.min.css">
# Developer Documentation
<p class="summary">Find useful resources, guides and reference material for developers.</p>
<input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
<div class="docreference">
<a href="/en/developer-guide"><img src="/img/icons/main_ico_compass.svg" alt="icon"><span>Developer Guide</span><span>(How Bitcoin works)</span></a>
<a href="/en/developer-reference"><img src="/img/icons/main_ico_guide.svg" alt="icon"><span>Developer Reference</span><span>(Technical details and APIs)</span></a>
<a href="/en/developer-examples"><img src="/img/icons/main_ico_hash.svg" alt="icon"><span>Developer Examples</span><span>(Examples you can use)</span></a>
<a href="/en/developer-guide"><img src="/img/icons/main_ico_compass.svg" alt="icon"><span>Guide</span></a>
<a href="/en/developer-reference"><img src="/img/icons/main_ico_guide.svg" alt="icon"><span>Reference</span></a>
<a href="/en/developer-examples"><img src="/img/icons/main_ico_hash.svg" alt="icon"><span>Examples</span></a>
<a href="/en/developer-glossary"><img src="/img/icons/main_ico_abc.svg" alt="icon"><span>Glossary</span></a>
</div>
<div class="resources">
@ -89,3 +93,6 @@ title: "Developer Documentation - Bitcoin"
<p><a href="https://bitcoinj.github.io/#documentation">Bitcoinj Developer Documentation</a> - bitcoinj.org</p>
<p><a href="https://en.bitcoin.it/wiki/Category:Technical">Technical Pages</a> - Wiki</p>
</div></div>
<script src="/js/jquery-1.11.2.min.js"></script>
<script src="/js/jquery-ui.min.js"></script>
<script src="/js/devsearch.js"></script>

View file

@ -7,6 +7,7 @@ lang: en
id: developer-examples
title: "Developer Examples - Bitcoin"
---
<link rel="stylesheet" href="/css/jquery-ui.min.css">
# Bitcoin Developer Examples
@ -26,6 +27,8 @@ title: "Developer Examples - Bitcoin"
{% include fragment_reviews_needed.md %}
<input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
{% include example_intro.md %}
{% include example_testing.md %}
@ -37,8 +40,12 @@ title: "Developer Examples - Bitcoin"
{% include example_p2p_networking.md %}
{% include references.md %}
{{site.glossary_links}}
</div>
<script>updateToc();</script>
<script>addAnchorLinks();</script>
<script src="/js/jquery-1.11.2.min.js"></script>
<script src="/js/jquery-ui.min.js"></script>
<script src="/js/devsearch.js"></script>

View file

@ -0,0 +1,94 @@
---
# This file is licensed under the MIT License (MIT) available on
# http://opensource.org/licenses/MIT.
title: Developer Glossary - Bitcoin
layout: base
lang: en
---
<link rel="stylesheet" href="/css/jquery-ui.min.css">
{% capture markdown_content %}
# Bitcoin Developer Glossary
<input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
<div markdown="block" class="notice">
<span markdown="span">This is a technical glossary. Regular users should use the [vocabulary
page](/en/vocabulary).</span>
</div>
{% comment %}
## The following single-space-indented code (sorry, whitespace
## sensitive) takes the alphabetized array of individual hash objects
## and puts them in a list sorted by the first character of each term
## characters (case insensitive). E.g.:
##
## Alpha
## Apropos
##
## Beta
##
## Gamma
## Gnu
##
## The current style sheet gives each item a certain width and then
## floats them so terms starting with the same character are grouped
## together. Hopefully this strikes the right balance between
## information density and too much whitespace.
{% endcomment %}
## Numbers
<!-- no subhead-links here -->
{% for item in site.devsearches.Glossary %}
{% if forloop.first %}{% assign first_term = true %}{% else %}{% assign first_term = false %}{% endif %}
{% for term in item %}
{% capture text_and_link %}<a href="{{term[1]}}">{{term[0]}}</a>{% endcapture %}
{% capture first_character %}{{term[0] | downcase | truncate: 1, '' }}{% endcapture %}
{% if first_character == 'a' %}
{% assign finished_with_numbers = true %}
{% endif %}
{% if first_character == last_first_character %}
<li markdown="span">{{text_and_link}}</li>
{% else %}
{% unless first_term %}
</ul><br class="clear">
{% endunless %}
{% if finished_with_numbers %}
## {{ first_character | upcase }}
<!-- no subhead-links here -->
{% endif %}
{% case first_character %}
{% when 'b' %}
See also: [Bitcoin Improvement Proposals (BIPs)](https://github.com/bitcoin/bips#readme)
{% when 'o' %}
See also: [Op codes](https://en.bitcoin.it/wiki/Script#Words)
{% when 'p' %}
See also: [P2P protocol messages](/en/developer-reference#data-messages)
{% when 'r' %}
See also: [Bitcoin Core RPCs](/en/developer-reference#rpc-quick-reference)
{% endcase %}
<ul class="wrapped_list">
<li markdown="span">{{text_and_link}}</li>
{% endif %}
{% capture last_first_character %}{{first_character}}{% endcapture %}
{% endfor %}
{% endfor %}
{% comment %}Close off last list and end the float: {% endcomment %}
</ul><br class="clear">
<div markdown="block" class="notice">
<span markdown="span">Can't find what you're looking for? [Suggest a
new term][] for the glossary!</span>
</div>
[suggest a new term]: https://github.com/bitcoin/bitcoin.org/issues/new?title=New%20glossary%20term%20suggestion:
{% include references.md %}
{{site.glossary_links}}
{% endcapture %}
{{ markdown_content | markdownify }}
<script src="/js/jquery-1.11.2.min.js"></script>
<script src="/js/jquery-ui.min.js"></script>
<script src="/js/devsearch.js"></script>

View file

@ -7,6 +7,7 @@ lang: en
id: developer-guide
title: "Developer Guide - Bitcoin"
---
<link rel="stylesheet" href="/css/jquery-ui.min.css">
# Bitcoin Developer Guide
@ -31,6 +32,8 @@ of the following file. -->
{% include fragment_reviews_needed.md %}
<input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
{% include guide_intro.md %}
{% include guide_block_chain.md %}
@ -50,8 +53,12 @@ of the following file. -->
{% include guide_mining.md %}
{% include references.md %}
{{site.glossary_links}}
</div>
<script>updateToc();</script>
<script>addAnchorLinks();</script>
<script src="/js/jquery-1.11.2.min.js"></script>
<script src="/js/jquery-ui.min.js"></script>
<script src="/js/devsearch.js"></script>

View file

@ -7,6 +7,7 @@ lang: en
id: developer-reference
title: "Developer Reference - Bitcoin"
---
<link rel="stylesheet" href="/css/jquery-ui.min.css">
<!-- This should be empty, but comment it out just in case: {% include helpers/vars.md %} -->
@ -28,6 +29,8 @@ title: "Developer Reference - Bitcoin"
{% include fragment_reviews_needed.md %}
<input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
{% include ref_intro.md %}
{% include ref_block_chain.md %}
@ -241,8 +244,12 @@ untrusted source.
{% include ref/bitcoin-core/rest/requests/get_tx.md %}
{% include references.md %}
{{site.glossary_links}}
</div>
<script>updateToc();</script>
<script>addAnchorLinks();</script>
<script src="/js/jquery-1.11.2.min.js"></script>
<script src="/js/jquery-ui.min.js"></script>
<script src="/js/devsearch.js"></script>