Glossary: Various small fixes and improvements

Add link to the glossary from each definition
Fix missing BIP37 link
Fix searchbox width on mobiles
Apply more consistent margin and padding for the searchbox
Use H3 titles in the glossary_entry layout for better readability
Always use HTML classes for CSS stylesheets
Fix one typo in glossary.rb
This commit is contained in:
Saivann 2015-04-09 14:21:03 -04:00 committed by David A. Harding
parent af29f6855c
commit a790f353d0
No known key found for this signature in database
GPG key ID: 4B29C30FF29EC4B7
9 changed files with 19 additions and 16 deletions

View file

@ -22,7 +22,7 @@ optional:
links_html_or_markdown_style_capitalize_first_letter: links_html_or_markdown_style_capitalize_first_letter:
- "[Bloom filter](/en/developer-guide#bloom-filters) --- Bitcoin.org Developer Guide" - "[Bloom filter](/en/developer-guide#bloom-filters) --- Bitcoin.org Developer Guide"
- "[BIP37: Connection Bloom Filtering] --- Bitcoin Improvement Proposals" - "[BIP37: Connection Bloom Filtering](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki)--- Bitcoin Improvement Proposals"
- "[Pull request that implemented bloom filters in Bitcoin Core](https://github.com/bitcoin/bitcoin/pull/1795) --- GitHub" - "[Pull request that implemented bloom filters in Bitcoin Core](https://github.com/bitcoin/bitcoin/pull/1795) --- GitHub"
- "[Discussion about bloom filtering and SPV clients](https://bitcointalk.org/index.php?topic=252937.0) --- BitcoinTalk" - "[Discussion about bloom filtering and SPV clients](https://bitcointalk.org/index.php?topic=252937.0) --- BitcoinTalk"

View file

@ -15,11 +15,10 @@ lang: en
# {{page.required.title_max_40_characters_no_formatting}} # {{page.required.title_max_40_characters_no_formatting}}
<input id="glossary_term" placeholder="Search the glossary, RPCs, and more"> <input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
<div markdown="block" class="notice"> <div markdown="block" class="notice">
<span markdown="span">This is a technical glossary. Regular users should use the [vocabulary <span markdown="span">This definition comes from the [technical glossary](/en/developer-glossary).</span>
page](/en/vocabulary).</span>
</div> </div>
## Definition ## Definition
@ -30,14 +29,14 @@ page](/en/vocabulary).</span>
{% endautocrossref %} {% endautocrossref %}
## Synonyms ### Synonyms
{% for synonym in page.required.synonyms_shown_in_glossary_capitalize_first_letter %} {% for synonym in page.required.synonyms_shown_in_glossary_capitalize_first_letter %}
* {{synonym}} * {{synonym}}
{% endfor %} {% endfor %}
{% if page.optional.not_to_be_confused_with_capitalize_first_letter %} {% if page.optional.not_to_be_confused_with_capitalize_first_letter %}
## Not To Be Confused With ### Not To Be Confused With
{% autocrossref %} {% autocrossref %}
@ -50,7 +49,7 @@ page](/en/vocabulary).</span>
{% endif %} {% endif %}
{% if page.optional.links_html_or_markdown_style_capitalize_first_letter %} {% if page.optional.links_html_or_markdown_style_capitalize_first_letter %}
## Links ### Links
{% for link in page.optional.links_html_or_markdown_style_capitalize_first_letter %} {% for link in page.optional.links_html_or_markdown_style_capitalize_first_letter %}
* {{link}} * {{link}}
{% endfor %} {% endfor %}

View file

@ -664,7 +664,7 @@ table td,table th{
} }
.docreference a{ .docreference a{
display:inline-block; display:inline-block;
margin:0 0 40px 0; margin:20px 0 40px 0;
font-size:125%; font-size:125%;
width:150px; width:150px;
} }
@ -907,9 +907,10 @@ table td,table th{
border:2px solid #ee9209; border:2px solid #ee9209;
color:#fff; color:#fff;
} }
#glossary_term { .glossary_term {
display: block; display: block;
width: 20em; width: 20em;
padding: 5px 10px;
margin-right: auto; margin-right: auto;
margin-left: auto; margin-left: auto;
} }
@ -2215,6 +2216,9 @@ h2 .rssicon{
display:block; display:block;
margin:0 auto 40px auto; margin:0 auto 40px auto;
} }
.glossary_term {
width: 80%;
}
.toc{ .toc{
position:static; position:static;
margin-top:0px; margin-top:0px;

View file

@ -113,7 +113,7 @@ module Jekyll
glossary_dir='_data/glossary/en' glossary_dir='_data/glossary/en'
#generate each release based on templates #Generate each definition page based on templates
Dir.foreach(glossary_dir) do |file| Dir.foreach(glossary_dir) do |file|
next if file == '.' or file == '..' next if file == '.' or file == '..'
lang = 'en' lang = 'en'
@ -122,7 +122,7 @@ module Jekyll
output_directory = lang + '/glossary/' output_directory = lang + '/glossary/'
site.pages << GlossaryPage.new(site, site.source, lang, glossary_dir, src, output_directory) site.pages << GlossaryPage.new(site, site.source, lang, glossary_dir, src, output_directory)
end end
#TODO releases are only generated for English language, #TODO definition pages are only generated for English language,
#but they could also be translated at some point. They would however #but they could also be translated at some point. They would however
#need to fallback to English when no translation is available. #need to fallback to English when no translation is available.
end end

View file

@ -13,7 +13,7 @@ title: "Developer Documentation - Bitcoin"
<p class="summary">Find useful resources, guides and reference material for developers.</p> <p class="summary">Find useful resources, guides and reference material for developers.</p>
<input id="glossary_term" placeholder="Search the glossary, RPCs, and more"> <input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
<div class="docreference"> <div class="docreference">
<a href="/en/developer-guide"><img src="/img/icons/main_ico_compass.svg" alt="icon"><span>Guide</span></a> <a href="/en/developer-guide"><img src="/img/icons/main_ico_compass.svg" alt="icon"><span>Guide</span></a>

View file

@ -27,7 +27,7 @@ title: "Developer Examples - Bitcoin"
{% include fragment_reviews_needed.md %} {% include fragment_reviews_needed.md %}
<input id="glossary_term" placeholder="Search the glossary, RPCs, and more"> <input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
{% include example_intro.md %} {% include example_intro.md %}

View file

@ -11,7 +11,7 @@ lang: en
{% capture markdown_content %} {% capture markdown_content %}
# Bitcoin Developer Glossary # Bitcoin Developer Glossary
<input id="glossary_term" placeholder="Search the glossary, RPCs, and more"> <input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
<div markdown="block" class="notice"> <div markdown="block" class="notice">
<span markdown="span">This is a technical glossary. Regular users should use the [vocabulary <span markdown="span">This is a technical glossary. Regular users should use the [vocabulary

View file

@ -32,7 +32,7 @@ of the following file. -->
{% include fragment_reviews_needed.md %} {% include fragment_reviews_needed.md %}
<input id="glossary_term" placeholder="Search the glossary, RPCs, and more"> <input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
{% include guide_intro.md %} {% include guide_intro.md %}

View file

@ -29,7 +29,7 @@ title: "Developer Reference - Bitcoin"
{% include fragment_reviews_needed.md %} {% include fragment_reviews_needed.md %}
<input id="glossary_term" placeholder="Search the glossary, RPCs, and more"> <input id="glossary_term" class="glossary_term" placeholder="Search the glossary, RPCs, and more">
{% include ref_intro.md %} {% include ref_intro.md %}