August 2017 - tor-commits - lists.torproject.org

[nyx/master] Revamp our FAQ content
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit dc7b0896cd2a23730c2f82c91ea022f054f7bf0b Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jul 31 12:54:58 2017 -0700 Revamp our FAQ content Rewording most of our FAQ entries and adjusting their styling. Finally pretty happy with it! --- web/images/faq/acs_failure.png | Bin 161127 -> 151697 bytes web/index.html | 101 +++++++++++++++++++++-------------------- web/styles.css | 34 ++++++++++++-- 3 files changed, 84 insertions(+), 51 deletions(-) diff --git a/web/images/faq/acs_failure.png b/web/images/faq/acs_failure.png index cd44aa8..b540e66 100644 Binary files a/web/images/faq/acs_failure.png and b/web/images/faq/acs_failure.png differ diff --git a/web/index.html b/web/index.html index 2b68571..5ec9ea8 100644 --- a/web/index.html +++ b/web/index.html @@ -103,7 +103,7 @@ <li id="why_is_it_called_nyx"> <span>Why is it called Nyx?</span> <div class="answer"> - <a href="http://fallenlights.net/"><img src="images/faq/shadowgirl.jpg" alt="greek goddess" title="Nyx by Shadowgirl, used with permission." /></a> + <a class="nyx-img" href="http://fallenlights.net/"><img src="images/faq/shadowgirl.jpg" alt="greek goddess" title="Nyx by Shadowgirl, used with permission." /></a> <p style="min-height: 340px">Simple - because the <a href="https://en.wikipedia.org/wiki/Nyx">Greek goddess of night</a> is short and memorable. Terminal applications are handiest when they're brief and easy to type. Top, ssh, scp - anything longer is just begging to be aliased down.</p> </div> </li> @@ -111,7 +111,7 @@ <li id="does_nyx_have_any_dependencies"> <span>Does Nyx have any dependencies?</span> <div class="answer"> - <p><b>Yes</b>, Nyx requires <a href="https://stem.torproject.org/>">Stem 1.4.5 or later</a>. + <p><b>Yes</b>, Nyx requires <a href="https://stem.torproject.org/">Stem 1.5.4 or later</a>. </div> </li> @@ -125,9 +125,9 @@ <li id="are_there_any_other_tor_uis"> <span>Are there any other user interfaces for Tor?</span> <div class="answer"> - <img src="images/faq/vidalia.jpg" alt="vidalia" /> - <p>Yes, though sadly this isn't a space that gets much attention.</p> - <p>For years <a href="https://en.wikipedia.org/wiki/Vidalia_%28software%29">Vidalia</a> was the default interface of Tor until it was replaced in 2013 by <a href="https://www.torproject.org/projects/torbrowser.html.en">Tor Browser</a>. Vidalia includes a launcher, settings editor, map, and more. <a href="https://sourceforge.net/projects/tork/">TorK</a> is similar, providing connection information as well but never reached the same level of prominence. Both interfaces are now unmaintained.</p> + <p>Yes, though sadly this space doesn't get much attention.</p> + <p>For years <a href="https://en.wikipedia.org/wiki/Vidalia_%28software%29">Vidalia</a> was the default interface of Tor until it was replaced by <a href="https://www.torproject.org/projects/torbrowser.html.en">Tor Browser</a> in 2013. Vidalia includes a launcher, settings editor, map, and more. <a href="https://sourceforge.net/projects/tork/">TorK</a> is similar, providing connection information as well but never reached the same level of prominence. Both interfaces are now unmaintained.</p> + <img class="vidalia-img" src="images/faq/vidalia.jpg" alt="vidalia" /> <p>Smaller widgets include...</p> <ul> @@ -151,36 +151,36 @@ </li> </ul> - <div class="section"></div> + <div class="faq-section" style="padding-top: 35px;"></div> <a href="#usage" class="section-title">Usage</a> <br /><br /> <ul class="questions"> - <li id="will_exits_include_user_traffic"> - <span>When running an exit will I see people's traffic?</span> + <li id="will_i_see_other_peoples_traffic"> + <span>Will I see other people's traffic?</span> <div class="answer"> - <p><b>No</b>. Potential client and exit connections are scrubbed of sensitive information. Be aware that it's highly discouraged (and possibly illegal) for relay operators to view this data, so please don't.</p> + <p><b>No</b>. Potential client and exit connections are scrubbed of sensitive information. Be aware that it's highly discouraged (and likely illegal) for relay operators to view this data, so please don't.</p> </div> </li> - <li id="is_it_harmful_to_share_data"> - <span>Is it harmful to share the information provided by Nyx?</span> + <li id="is_it_harmful_to_share_information_i_see"> + <span>Is it harmful to share information I see?</span> <div class="answer"> <p><b>Not really</b>, but show some moderation. Screenshots of Nyx are unlikely to do any harm but try to avoid exposing data en mass.</p> </div> </li> - <li id="can_nyx_leak_data"> - <span>Is there any chance that nyx will leak data?</span> + <li id="can_running_nyx_leak_data"> + <span>Can running Nyx leak data?</span> <div class="answer"> - <p><b>No</b>. Nyx is a completely passive listener, fetching all information from either Tor or the local system.</p> + <p><b>No</b>. As a passive listener Nyx retrieves everything it needs from your local system. Nothing goes over the network.</p> </div> </li> - <li id="why_dont_i_see_the_bandwith_graph"> - <span>Why don't I see the bandwidth graph?</span> + <li id="why_cant_i_see_the_bandwith_graph"> + <span>Why can't I see the bandwidth graph?</span> <div class="answer"> - <p>On some terminals such as Gentoo screen sessions appear to have a bug where highlighted spaces aren't shown. Try running...</p> + <p>Some terminals, such as screen sessions on Gentoo, apparently have a bug where highlighted space characters are not shown. Try running...</p> <pre>export TERM="rxvt-unicode"</pre> </div> </li> @@ -188,20 +188,19 @@ <li id="why_are_borders_broken"> <span>Why are there borders like 'mwqqqqqqqqj'?</span> <div class="answer"> - <p>If you're getting something that looks like...</p> - <a href="images/screenshots/acs_failure.png"><img src="images/faq/acs_failure.png" alt="acs display failure" /></a> - <p>... you are encountering a terminal bug where alternate character support (ACS) <a href="http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing">is unavailable</a>.</p> - <p>Unfortunately there doesn't seem to be a way for Nyx to automatically detect or correct this. To work around this you can set the following in your nyxrc to not use ACS borders...</p> + <a class="acs-img" href="images/screenshots/acs_failure.png"><img src="images/faq/acs_failure.png" alt="acs display failure" /></a> + <p>When alternate character support (ACS) <a href="http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing">is unavailable</a> borders become characters like the picture above. This is a terminal bug.</p> + <p>Unfortunately there doesn't seem to be a way for Nyx to automatically detect this. However, when it happens this <b>can</b> be easily corrected. Simply run <i>reset</i>. To tell Nyx not to use ACS borders simply add the following to your nyxrc...</p> <pre>features.acsSupport false</pre> </div> </li> <li id="why_are_relay_details_missing"> - <span>Why are relay details for connections missing?</span> + <span>Why are connections missing relay details?</span> <div class="answer"> - <p>Relays publish information about themselves in documents called <i>descriptors</i>. These documents are downloaded by Tor. New documents available on an hourly basis but Tor will only download them if it needs them, so the descriptors you have may be older.</p> - <p>Nyx's connections page use these descriptors to enrich connection information with data about the relay you're connected with. If Tor doesn't have this information the data may be stale or missing.</p> - <p><b>This is fine.</b> Descriptor information we use changes infrequently so even if they're a few hours old it won't matter. However, if you really need up-to-date information you can add the following to your torrc...</p> + <p>Nyx presents your <a href="images/features/connections.png">active connections</a> correlated with tor consensus data. This means that in addition to the IP/port we also provide Tor-specific information such as your connection's relay fingerprint, nickname, contact address, and much more.</p> + <p>However, sometimes this extra information is missing <b>and that's fine</b>. Relays publish information about themselves on an hourly basis in documents called <a href="https://stem.torproject.org/tutorials/mirror_mirror_on_the_wall.html#what-i…">descriptors</a>. Tor downloads only the descriptors it needs to run, so Tor may not have information about all the relays you're connecting to. And that's ok.</p> + <p>However, if you need up-to-date information you can add the following to your torrc...</p> <pre># download new descriptors even if our cache is still valid @@ -212,7 +211,7 @@ FetchUselessDescriptors 1</pre> </li> </ul> - <div class="section"></div> + <div class="faq-section"></div> <a href="#development" class="section-title">Development</a> <br /><br /> @@ -220,29 +219,36 @@ FetchUselessDescriptors 1</pre> <li id="how_do_i_get_started"> <span>How do I get started?</span> <div class="answer"> - <p>The best way of getting involved with any project is to jump right in! Our <a href="http://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug tracker</a> lists several development tasks. In particular look for the 'easy' keyword when getting started. If you have any questions then I'm always more than happy to help! I'm <b>atagar</b> on <a href="http://www.oftc.net/">oftc</a> and also available <a href="https://www.atagar.com/contact/">via email</a>.</p> - <p>To start hacking on Nyx please do the following and don't hesitate to let me know if you get stuck or would like to discuss anything!</p> + <p>The best way of getting involved with any project is to jump right in! In particular look for the <i>easy</i> keyword on our <a href="http://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug tracker</a> for a handy spot to start.</p> + <p>Got questions? I'm <b>atagar</b> on <a href="http://www.oftc.net/">oftc</a> and available <a href="https://www.atagar.com/contact/">via email</a>. To get started...</p> + + <ol> + <li>Clone our <a href="http://git-scm.com/">git</a> repository...<pre>git clone https://git.torproject.org/nyx.git</pre><br /></li> + <li>Install our test dependencies<pre>sudo pip install mock pyflakes pycodestyle</pre><br /></li> + <li>Install the development version of <a href="https://stem.torproject.org/">Stem</a>...<pre>git clone https://git.torproject.org/stem.git +cd stem +sudo python setup.py install</pre><br /></li> + <li>Find a <a href="https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug or feature</a> that sounds fun and dig in!</li> + </ol> + </div> + </li> + <li id="how_do_i_file_a_pull_request"> + <span>How do I file a pull request?</span> + <div class="answer"> + <p>Got something to send my way? It's easy...</p> <ol> - <li>Clone our <a href="http://git-scm.com/">git</a> repository: <b>git clone https://git.torproject.org/nyx.git</b></li> - <li>Install the development version of <a href="https://stem.torproject.org/">Stem</a>: <b>git clone https://git.torproject.org/stem.git; cd stem; sudo python setup.py install</b>.</li> - <li>Get our test dependencies: <b>sudo pip install mock pep8 pyflakes</b>.</li> - <li>Find a <a href="https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug or feature</a> that sounds interesting.</li> - <li>When you have something that you would like to contribute back do the following... + <li>Make a publicly accessible repository for me to pull from. If you don't already have one <a href="https://github.com/">GitHub</a> is great for this.<br /><br /></li> + <li>File a <a href="https://trac.torproject.org/projects/tor/newticket">trac ticket</a>. Only fields you'll need are...<br /><br /> <ul> - <li>If you don't already have a publicly accessible Nyx repository then set one up. <a href="https://github.com/">GitHub</a> in particular is great for this.</li> - <li>File a <a href="https://trac.torproject.org/projects/tor/newticket">trac ticket</a>, the only fields you'll need are... - <ul> - <li><b>Summary</b>: short description of your change</li> - <li><b>Description</b>: longer description and a link to your repository with either the git commits or branch that has your change</li> - <li><b>Type</b>: 'defect' if this is a bug fix and 'enhancement' otherwise</li> - <li><b>Priority</b>: rough guess at the priority of your change</li> - <li><b>Component</b>: Core Tor / Nyx</li> - </ul> - </li> - <li>I'll review the change and give suggestions. When we're both happy with it I'll push your change to the official repository.</li> + <li><b>Summary</b>: brief description of your change</li> + <li><b>Description</b>: description of your change and a link to your repository for me to pull from</li> + <li><b>Type</b>: 'defect' if this is a bug fix and 'enhancement' otherwise</li> + <li><b>Component</b>: Core Tor → Nyx</li> </ul> + <br /> </li> + <li>I'll review your change and give suggestions. When we're both happy with it I'll push your change to the official repository.</li> </ol> </div> </li> @@ -250,9 +256,8 @@ FetchUselessDescriptors 1</pre> <li id="how_do_i_run_the_tests"> <span>How do I run the tests?</span> <div class="answer"> - <p>Nyx has unit tests, including tests that exercise our curses functionality. When you run the tests you may notice your console flicker as these are exercised.</p> - <p>If you have them installed we run <a href="https://launchpad.net/pyflakes">pyflakes</a> to do static error checking and <a href="http://pycodestyle.readthedocs.org/en/latest/">pycodestyle</a> for style checking as part of our tests.</p> - <p>Tests are run with...</p> + <p>Nyx has unit tests that exercise our curses functionality. When you run the tests you'll probably notice your console flicker as these tests are exercised. This is normal. Testing also runs <a href="https://launchpad.net/pyflakes">pyflakes</a> and <a href="http://pycodestyle.readthedocs.org/en/latest/">pycodestyle</a> in the background.<p> + <p>Running our tests is simple...</p> <pre>% run_tests.py</pre> </div> </li> @@ -372,7 +377,7 @@ FetchUselessDescriptors 1</pre> var newHeight = 0; answer.children().each(function () { - if (this.tagName == "P") { + if (["nyx-img", "vidalia-img"].indexOf(this.className) == -1) { newHeight += $(this).outerHeight(true); } }); diff --git a/web/styles.css b/web/styles.css index fb839ca..88aac94 100644 --- a/web/styles.css +++ b/web/styles.css @@ -154,9 +154,16 @@ Front Page FAQ Page ============================================================*/ +.faq-section { + border-bottom: 1px solid #856231; + margin-bottom: -16px; + padding-top: 30px; +} + .questions { margin: 0px; padding-left: 15px; + padding-bottom: 0px; } .questions li { @@ -179,15 +186,36 @@ FAQ Page padding: 0px; } -.answer img { +.answer p { + margin-bottom: 10px; + margin-top: 5px; +} + +.answer pre { + margin-bottom: 0px; + padding-bottom: 0px; +} + +.answer ol { + margin-top: 20px; +} + +.nyx-img { float: right; margin-top: 5px; margin-left: 20px; } -.answer p { +.vidalia-img { + float: right; + margin-top: -15px; + margin-left: 20px; +} + +.acs-img { + display: block; /* needed so expanding uses the content's height */ margin-bottom: 10px; - margin-top: 5px; + margin-top: 10px; } /*============================================================

1 0

[nyx/master] Only open/close FAQ entry when clicking question
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit d58594db4215e6ec6ff90a686ef2270103a51361 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jul 28 16:42:00 2017 -0700 Only open/close FAQ entry when clicking question FAQ entries shouldn't close when the answer is clicked. Otherwise you can't copy text. --- web/index.html | 4 ++-- web/styles.css | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/web/index.html b/web/index.html index bae6170..e1c3c6d 100644 --- a/web/index.html +++ b/web/index.html @@ -207,8 +207,8 @@ // show/hide for FAQ questions - $('.question').click(function() { - var answer = $(this).find('.answer'); + $('.question > span').click(function() { + var answer = $(this).parent().find('.answer'); if (answer.is('.open')) { answer.animate({'height': '0'}, 100); diff --git a/web/styles.css b/web/styles.css index ba7ddd5..081ff27 100644 --- a/web/styles.css +++ b/web/styles.css @@ -168,6 +168,7 @@ FAQ Page } .answer { + cursor: default; height: 0px; overflow: hidden; padding: 0px; @@ -175,7 +176,7 @@ FAQ Page .answer img { float: right; - margin-top: 0px; + margin-top: 5px; margin-left: 20px; }

1 0

[nyx/master] Drop wrapper 'panes' div
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit 981e666340bea021408c1a9aebe23b05514f1e98 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jul 28 16:49:52 2017 -0700 Drop wrapper 'panes' div Oh. Thought this was necessary for tabs to work but that turns out not to be the case. Neat. --- web/index.html | 252 ++++++++++++++++++++++++++++----------------------------- web/styles.css | 4 +- 2 files changed, 127 insertions(+), 129 deletions(-) diff --git a/web/index.html b/web/index.html index e1c3c6d..5da37bf 100644 --- a/web/index.html +++ b/web/index.html @@ -25,167 +25,165 @@ </div> </div> - <div class="panes"> - <div id="home" class="content"> - <div id="welcome" class="section"></div> - <a href="#welcome" class="section-title">Welcome to Nyx</a> + <div id="home" class="page"> + <div id="welcome" class="section"></div> + <a href="#welcome" class="section-title">Welcome to Nyx</a> - <p>Nyx is a command-line monitor for <a href="https://www.torproject.org/">Tor</a>. With this you can get detailed real-time information about your relay such as bandwidth usage, connections, logs, and much more.</p> + <p>Nyx is a command-line monitor for <a href="https://www.torproject.org/">Tor</a>. With this you can get detailed real-time information about your relay such as bandwidth usage, connections, logs, and much more.</p> - <p>Nyx's latest version is <b>1.4.5</b>, released April 28th, 2012. Prior to our upcoming release this application went under the name of '<b>arm</b>'. Sorry for the confusion!</p> + <p>Nyx's latest version is <b>1.4.5</b>, released April 28th, 2012. Prior to our upcoming release this application went under the name of '<b>arm</b>'. Sorry for the confusion!</p> - <div id="features" class="section"></div> - <a href="#features" class="section-title">What does Nyx provide?</a> + <div id="features" class="section"></div> + <a href="#features" class="section-title">What does Nyx provide?</a> - <div class="feature"> - <a id="bandwidth"></a> - <a href="images/screenshots/front_page.png"><img src="images/features/bandwidth.png" alt="bandwidth" /></a> - <span class="feature-arrow">«</span><a href="#bandwidth" class="feature-title">Bandwidth Graph</a> - <p>Bandwidth used by Tor. You can press 'i' to pick the graphing <b>interval</b>, or 's' to show other usage <b>statistics</b>.</p> - </div> + <div class="feature"> + <a id="bandwidth"></a> + <a href="images/screenshots/front_page.png"><img src="images/features/bandwidth.png" alt="bandwidth" /></a> + <span class="feature-arrow">«</span><a href="#bandwidth" class="feature-title">Bandwidth Graph</a> + <p>Bandwidth used by Tor. You can press 'i' to pick the graphing <b>interval</b>, or 's' to show other usage <b>statistics</b>.</p> + </div> - <div class="feature"> - <a id="events"></a> - <a href="images/screenshots/front_page.png"><img src="images/features/events.png" alt="event log" /></a> - <span class="feature-arrow">«</span><a href="#events" class="feature-title">Event Log</a> - <p>Tor logs a wealth of information about itself. We present it, colorized and deuplicated. Press 'e' to select what <b>events</b> are logged and 'f' to <b>filter</b> to just what you want.</p> - </div> + <div class="feature"> + <a id="events"></a> + <a href="images/screenshots/front_page.png"><img src="images/features/events.png" alt="event log" /></a> + <span class="feature-arrow">«</span><a href="#events" class="feature-title">Event Log</a> + <p>Tor logs a wealth of information about itself. We present it, colorized and deuplicated. Press 'e' to select what <b>events</b> are logged and 'f' to <b>filter</b> to just what you want.</p> + </div> - <div class="feature"> - <a id="connections"></a> - <a href="images/screenshots/connections.png"><img src="images/features/connections.png" alt="connections" /></a> - <span class="feature-arrow">«</span><a href="#connections" class="feature-title">Connections</a> - <p>Connection data similar to netstat or lsof, but correlated with Tor relay information to make it much richer. Press 'enter' for more <b>details</b>, 's' to <b>sort</b>, and 'd' to see raw <b>descriptor</b> data.</p> - </div> + <div class="feature"> + <a id="connections"></a> + <a href="images/screenshots/connections.png"><img src="images/features/connections.png" alt="connections" /></a> + <span class="feature-arrow">«</span><a href="#connections" class="feature-title">Connections</a> + <p>Connection data similar to netstat or lsof, but correlated with Tor relay information to make it much richer. Press 'enter' for more <b>details</b>, 's' to <b>sort</b>, and 'd' to see raw <b>descriptor</b> data.</p> + </div> - <div class="feature"> - <a id="config_editor"></a> - <a href="images/screenshots/config_editor.png"><img src="images/features/config_editor.png" alt="configuration editor" /></a> - <span class="feature-arrow">«</span><a href="#config_editor" class="feature-title">Configuration Editor</a> - <p>Editor to change Tor's setting on the fly, with usage information from its manual. Press 'enter' to <b>change</b> Tor settings and 'w' to <b>write</b> your changes to disk.</p> - </div> + <div class="feature"> + <a id="config_editor"></a> + <a href="images/screenshots/config_editor.png"><img src="images/features/config_editor.png" alt="configuration editor" /></a> + <span class="feature-arrow">«</span><a href="#config_editor" class="feature-title">Configuration Editor</a> + <p>Editor to change Tor's setting on the fly, with usage information from its manual. Press 'enter' to <b>change</b> Tor settings and 'w' to <b>write</b> your changes to disk.</p> + </div> - <div class="feature"> - <a id="torrc"></a> - <a href="images/screenshots/torrc.png"><img src="images/features/torrc.png" alt="torrc" /></a> - <span class="feature-arrow">«</span><a href="#torrc" class="feature-title">Torrc</a> - <p>Provides your torrc with line numbers and syntax highlighting. Comments can be <b>stripped</b> by pressing 's'.</p> - </div> + <div class="feature"> + <a id="torrc"></a> + <a href="images/screenshots/torrc.png"><img src="images/features/torrc.png" alt="torrc" /></a> + <span class="feature-arrow">«</span><a href="#torrc" class="feature-title">Torrc</a> + <p>Provides your torrc with line numbers and syntax highlighting. Comments can be <b>stripped</b> by pressing 's'.</p> + </div> - <div class="feature"> - <a id="interpreter"></a> - <a href="images/screenshots/interpreter.png"><img src="images/features/interpreter.png" alt="interpreter" /></a> - <span class="feature-arrow">«</span><a href="#interpreter" class="feature-title">Interpreter</a> - <p>Integration with <a href="https://stem.torproject.org/">Stem's</a> <a href="https://stem.torproject.org/tutorials/down_the_rabbit_hole.html">interpreter</a>, providing <a href="https://gitweb.torproject.org/torspec.git/tree/control-spec.txt">raw controller access</a>, irc-style commands like <b>/help</b>, tab completion, history scrollback, and a python prompt.</p> - </div> + <div class="feature"> + <a id="interpreter"></a> + <a href="images/screenshots/interpreter.png"><img src="images/features/interpreter.png" alt="interpreter" /></a> + <span class="feature-arrow">«</span><a href="#interpreter" class="feature-title">Interpreter</a> + <p>Integration with <a href="https://stem.torproject.org/">Stem's</a> <a href="https://stem.torproject.org/tutorials/down_the_rabbit_hole.html">interpreter</a>, providing <a href="https://gitweb.torproject.org/torspec.git/tree/control-spec.txt">raw controller access</a>, irc-style commands like <b>/help</b>, tab completion, history scrollback, and a python prompt.</p> + </div> - <div class="feature"> - <a id="and_more"></a> - <img src="images/features/menu.png" alt="menu" /> - <span class="feature-arrow">«</span><a href="#and_more" class="feature-title">... and more!</a> - <p>That's just the tip of the iceburg. All pages within Nyx provide <b>help</b> information when you press 'h' and <b>menu</b> in response to 'm'. So go explore!</p> - </div> + <div class="feature"> + <a id="and_more"></a> + <img src="images/features/menu.png" alt="menu" /> + <span class="feature-arrow">«</span><a href="#and_more" class="feature-title">... and more!</a> + <p>That's just the tip of the iceburg. All pages within Nyx provide <b>help</b> information when you press 'h' and <b>menu</b> in response to 'm'. So go explore!</p> </div> + </div> - <div id="faq" class="content"> - <div class="section"></div> - <a href="#faq" class="section-title">Fact & Question</a> + <div id="faq" class="page"> + <div class="section"></div> + <a href="#faq" class="section-title">Fact & Question</a> - <br /><br /> + <br /><br /> - <div class="question" id="what_is_nyx"> - <span>What is Nyx?</span> - <div class="answer"> - <a href="images/screenshots/front_page.png"><img src="images/faq/front_page.png" alt="screenshot" /></a> - <p>Nyx is a command-line application for monitoring real time <a href="https://www.torproject.org/">Tor</a> status information. This includes bandwidth usage, logs, connections, configuration, and more.</p> - <p>As a curses interface Nyx is particularly well suited for ssh connections, tty terminals, and command-line aficionados.</p> - </div> + <div class="question" id="what_is_nyx"> + <span>What is Nyx?</span> + <div class="answer"> + <a href="images/screenshots/front_page.png"><img src="images/faq/front_page.png" alt="screenshot" /></a> + <p>Nyx is a command-line application for monitoring real time <a href="https://www.torproject.org/">Tor</a> status information. This includes bandwidth usage, logs, connections, configuration, and more.</p> + <p>As a curses interface Nyx is particularly well suited for ssh connections, tty terminals, and command-line aficionados.</p> </div> + </div> - <div class="question" id="why_is_it_called_nyx"> - <span>Why is it called Nyx?</span> - <div class="answer"> - <a href="http://fallenlights.net/"><img src="images/faq/shadowgirl.jpg" alt="greek goddess" title="Nyx by Shadowgirl, used with permission." /></a> - <p style="min-height: 340px">Simple - because the <a href="https://en.wikipedia.org/wiki/Nyx">Greek goddess of night</a> is short and memorable. Terminal applications are handiest when they're brief and easy to type. Top, ssh, scp - anything longer is just begging to be aliased down.</p> - </div> + <div class="question" id="why_is_it_called_nyx"> + <span>Why is it called Nyx?</span> + <div class="answer"> + <a href="http://fallenlights.net/"><img src="images/faq/shadowgirl.jpg" alt="greek goddess" title="Nyx by Shadowgirl, used with permission." /></a> + <p style="min-height: 340px">Simple - because the <a href="https://en.wikipedia.org/wiki/Nyx">Greek goddess of night</a> is short and memorable. Terminal applications are handiest when they're brief and easy to type. Top, ssh, scp - anything longer is just begging to be aliased down.</p> </div> </div> + </div> - <div id="download" class="content"> - <div class="section"></div> - <a href="#download" class="section-title">Download</a> + <div id="download" class="page"> + <div class="section"></div> + <a href="#download" class="section-title">Download</a> - <p>Nyx is available Mac OSX, Linux, and BSD but <a href="#windows">not Windows</a>. Find your platform below to get started.</p> + <p>Nyx is available Mac OSX, Linux, and BSD but <a href="#windows">not Windows</a>. Find your platform below to get started.</p> - <br /> + <br /> - <div class="platform"> - <a href="https://pypi.python.org/pypi/nyx/" id="pypi"><img src="images/download/pypi.png" alt="PyPI" /></a> - <a href="https://pypi.python.org/pypi/nyx/" class="platform-title">Python Package Index</a> - <p>Signed releases and instructions for both Python 2.x and 3.x. You can easily install from its <a href="https://www.atagar.com/arm/resources/static/arm-1.4.5.0.tar.bz2">tarball</a> (<a href="https://www.atagar.com/arm/resources/static/arm-1.4.5.0.tar.bz2.asc">sig</a>), or with <b>pip</b>...</p> - <pre> + <div class="platform"> + <a href="https://pypi.python.org/pypi/nyx/" id="pypi"><img src="images/download/pypi.png" alt="PyPI" /></a> + <a href="https://pypi.python.org/pypi/nyx/" class="platform-title">Python Package Index</a> + <p>Signed releases and instructions for both Python 2.x and 3.x. You can easily install from its <a href="https://www.atagar.com/arm/resources/static/arm-1.4.5.0.tar.bz2">tarball</a> (<a href="https://www.atagar.com/arm/resources/static/arm-1.4.5.0.tar.bz2.asc">sig</a>), or with <b>pip</b>...</p> + <pre> % sudo easy_install pip % sudo pip install nyx </pre> - </div> + </div> - <div class="platform"> - <a id="osx"><img src="images/download/osx.png" alt="OSX" /></a> - <span class="platform-title">Mac OSX</span> - <p>As of OSX 10.8 the platform bundles Python 2.7 by default. This makes installation easy...</p> - <pre> + <div class="platform"> + <a id="osx"><img src="images/download/osx.png" alt="OSX" /></a> + <span class="platform-title">Mac OSX</span> + <p>As of OSX 10.8 the platform bundles Python 2.7 by default. This makes installation easy...</p> + <pre> % sudo easy_install pip % sudo pip install nyx </pre> - </div> + </div> - <div class="platform"> - <a href="http://packages.debian.org/sid/tor-arm" id="debian"><img src="images/download/debian.png" alt="Debian" /></a> - <a href="http://packages.debian.org/sid/tor-arm" class="platform-title">Debian</a> - <p>Package maintained by Dererk for Debian.</p> - <pre>% sudo apt-get install tor-arm</pre> - </div> + <div class="platform"> + <a href="http://packages.debian.org/sid/tor-arm" id="debian"><img src="images/download/debian.png" alt="Debian" /></a> + <a href="http://packages.debian.org/sid/tor-arm" class="platform-title">Debian</a> + <p>Package maintained by Dererk for Debian.</p> + <pre>% sudo apt-get install tor-arm</pre> + </div> - <div class="platform"> - <a href="https://launchpad.net/ubuntu/+source/tor-arm" id="ubuntu"><img src="images/download/ubuntu.png" alt="Ubuntu" /></a> - <a href="https://launchpad.net/ubuntu/+source/tor-arm" class="platform-title">Ubuntu</a> - <p>Package derived from Debian for Ubuntu.</p> - <pre>% sudo apt-get install tor-arm</pre> - </div> + <div class="platform"> + <a href="https://launchpad.net/ubuntu/+source/tor-arm" id="ubuntu"><img src="images/download/ubuntu.png" alt="Ubuntu" /></a> + <a href="https://launchpad.net/ubuntu/+source/tor-arm" class="platform-title">Ubuntu</a> + <p>Package derived from Debian for Ubuntu.</p> + <pre>% sudo apt-get install tor-arm</pre> + </div> - <div class="platform"> - <a href="https://apps.fedoraproject.org/packages/tor-arm" id="fedora"><img src="images/download/fedora.png" alt="Fedora" /></a> - <a href="https://apps.fedoraproject.org/packages/tor-arm" class="platform-title">Fedora</a> - <p>Packages maintained by Juan for Fedora.</p> - <pre>% sudo yum install tor-arm</pre> - </div> + <div class="platform"> + <a href="https://apps.fedoraproject.org/packages/tor-arm" id="fedora"><img src="images/download/fedora.png" alt="Fedora" /></a> + <a href="https://apps.fedoraproject.org/packages/tor-arm" class="platform-title">Fedora</a> + <p>Packages maintained by Juan for Fedora.</p> + <pre>% sudo yum install tor-arm</pre> + </div> - <div class="platform"> - <a href="http://packages.gentoo.org/package/net-misc/arm" id="gentoo"><img src="images/download/gentoo.png" alt="Gentoo" /></a> - <a href="http://packages.gentoo.org/package/net-misc/arm" class="platform-title">Gentoo</a> - <p>Package maintained by Jesse for Gentoo.</p> - <pre>% sudo emerge arm</pre> - </div> + <div class="platform"> + <a href="http://packages.gentoo.org/package/net-misc/arm" id="gentoo"><img src="images/download/gentoo.png" alt="Gentoo" /></a> + <a href="http://packages.gentoo.org/package/net-misc/arm" class="platform-title">Gentoo</a> + <p>Package maintained by Jesse for Gentoo.</p> + <pre>% sudo emerge arm</pre> + </div> - <div class="platform"> - <a href="https://slackbuilds.org/repository/13.37/network/arm/" id="slackware"><img src="images/download/slackware.png" alt="Slackware" /></a> - <a href="https://slackbuilds.org/repository/13.37/network/arm/" class="platform-title">Slackware</a> - <p>Package maintained by pyllyukko for <a href="http://slackbuilds.org/howto/">Slackware</a>.</p> - </div> + <div class="platform"> + <a href="https://slackbuilds.org/repository/13.37/network/arm/" id="slackware"><img src="images/download/slackware.png" alt="Slackware" /></a> + <a href="https://slackbuilds.org/repository/13.37/network/arm/" class="platform-title">Slackware</a> + <p>Package maintained by pyllyukko for <a href="http://slackbuilds.org/howto/">Slackware</a>.</p> + </div> - <div class="platform"> - <a href="http://www.freshports.org/security/arm" id="freebsd"><img src="images/download/freebsd.png" alt="FreeBSD" /></a> - <a href="http://www.freshports.org/security/arm" class="platform-title">FreeBSD</a> - <p>Port maintained by Carlo for <a href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.html">FreeBSD</a>.</p> - <pre>% pkg install security/arm</pre> - </div> + <div class="platform"> + <a href="http://www.freshports.org/security/arm" id="freebsd"><img src="images/download/freebsd.png" alt="FreeBSD" /></a> + <a href="http://www.freshports.org/security/arm" class="platform-title">FreeBSD</a> + <p>Port maintained by Carlo for <a href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.html">FreeBSD</a>.</p> + <pre>% pkg install security/arm</pre> + </div> - <div class="platform"> - <a href="https://gitweb.torproject.org/nyx.git" id="git"><img src="images/download/git.png" alt="Git" /></a> - <a href="https://gitweb.torproject.org/nyx.git" class="platform-title">Source Repository</a> - <p>For those that want to live on the bleeding edge or contribute, Nyx's git repository can be fetched with...</p> - <pre>% git clone https://git.torproject.org/nyx.git</pre> - </div> + <div class="platform"> + <a href="https://gitweb.torproject.org/nyx.git" id="git"><img src="images/download/git.png" alt="Git" /></a> + <a href="https://gitweb.torproject.org/nyx.git" class="platform-title">Source Repository</a> + <p>For those that want to live on the bleeding edge or contribute, Nyx's git repository can be fetched with...</p> + <pre>% git clone https://git.torproject.org/nyx.git</pre> </div> </div> @@ -194,10 +192,10 @@ // when provided an anchor select the tab it resides within var anchor = window.location.hash; - $(".tabs").tabs(".panes > .content", { history: true }); + $(".tabs").tabs(".page", { history: true }); if (anchor) { - $(".panes").children().each(function () { + $(".page").each(function () { if ($(this).find(anchor).length) { $(".tabs").data("tabs").click(this.id); document.getElementById(anchor.substr(1)).scrollIntoView(); diff --git a/web/styles.css b/web/styles.css index 081ff27..617b74b 100644 --- a/web/styles.css +++ b/web/styles.css @@ -91,7 +91,7 @@ Header Bar (logo and nav) Common Page Attributes ============================================================*/ -.content { +.page { background: white; border-radius: 10px; box-shadow: 0px 0px 25px rgba(0, 0, 0, 0.80); @@ -102,7 +102,7 @@ Common Page Attributes text-align: center; } -.content p { +.page p { margin: 20px 0px 0px; text-align: justify; }

1 0

[nyx/master] Couple initial FAQ entries
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit d5f57277fd9ac392a98e4026f20a1d683bac6e5e Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jul 28 10:02:28 2017 -0700 Couple initial FAQ entries Few issues with them. For instance, expanion doesn't uncover tall images and you can't copy text. But wanted to start with these since I've been wanting to use Shadowgirl's picture for a while. :P --- web/images/faq/front_page.png | Bin 0 -> 42523 bytes .../faq/resources/nyx_by_shadowgirl-d5oeuj8.jpg | Bin 0 -> 139956 bytes web/images/faq/shadowgirl.jpg | Bin 0 -> 37023 bytes web/index.html | 20 +++++++++++++------- web/styles.css | 6 ++++++ 5 files changed, 19 insertions(+), 7 deletions(-) diff --git a/web/images/faq/front_page.png b/web/images/faq/front_page.png new file mode 100644 index 0000000..541ee61 Binary files /dev/null and b/web/images/faq/front_page.png differ diff --git a/web/images/faq/resources/nyx_by_shadowgirl-d5oeuj8.jpg b/web/images/faq/resources/nyx_by_shadowgirl-d5oeuj8.jpg new file mode 100644 index 0000000..aaf47b8 Binary files /dev/null and b/web/images/faq/resources/nyx_by_shadowgirl-d5oeuj8.jpg differ diff --git a/web/images/faq/shadowgirl.jpg b/web/images/faq/shadowgirl.jpg new file mode 100644 index 0000000..d4a810c Binary files /dev/null and b/web/images/faq/shadowgirl.jpg differ diff --git a/web/index.html b/web/index.html index 646d7d2..2116b00 100644 --- a/web/index.html +++ b/web/index.html @@ -93,17 +93,21 @@ <br /><br /> - <div class="question" id="question_1"> - <span>Demo question 1</span> + <div class="question" id="what_is_nyx"> + <span>What is Nyx?</span> <div class="answer"> - <p>answer 1</p> + <a href="images/screenshots/front_page.png"><img src="images/faq/front_page.png" alt="screenshot" /></a> + <p>Nyx is a command-line application for monitoring real time <a href="https://www.torproject.org/">Tor</a> status information. This includes bandwidth usage, logs, connections, configuration, and more.</p> + <p>As a curses interface Nyx is particularly well suited for ssh connections, tty terminals, and command-line aficionados.</p> </div> </div> - <div class="question" id="question_2"> - <span>Demo question 2</span> + <div class="question" id="why_is_it_called_nyx"> + <span>Why is it called Nyx?</span> <div class="answer"> - <p>answer 2</p> + <a href="http://fallenlights.net/"><img src="images/faq/shadowgirl.jpg" alt="greek goddess" title="Nyx by Shadowgirl, used with permission." /></a> + <p>Simple - because it's short and memorable. Terminal applications are handiest when they're easy to remember and type, such as top, ssh, etc. Anything longer is just begging to be aliased down.</p> + <p>That, and because Nyx is the <a href="https://en.wikipedia.org/wiki/Nyx">Greek goddess of night</a>.</p> </div> </div> </div> @@ -214,7 +218,9 @@ var newHeight = 0; answer.children().each(function () { - newHeight += $(this).outerHeight(true); + if (this.tagName == "P") { + newHeight += $(this).outerHeight(true); + } }); answer.animate({'height': newHeight}, 100); diff --git a/web/styles.css b/web/styles.css index fcd0510..98a76c1 100644 --- a/web/styles.css +++ b/web/styles.css @@ -167,6 +167,12 @@ FAQ Page font-weight: bold; } +.question img { + float: right; + margin-top: 20px; + margin-left: 20px; +} + .answer { height: 0px; overflow: hidden;

1 0

[nyx/master] Unordered list dot for FAQ entries
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit 9f9c8e51414b3397456b46806409a7d9f5d95320 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 29 13:51:35 2017 -0700 Unordered list dot for FAQ entries Swapping our FAQ from a series of divs to ul entries. --- web/index.html | 314 +++++++++++++++++++++++++++++---------------------------- web/styles.css | 13 ++- 2 files changed, 171 insertions(+), 156 deletions(-) diff --git a/web/index.html b/web/index.html index b73fc4c..a9c0ca4 100644 --- a/web/index.html +++ b/web/index.html @@ -91,171 +91,181 @@ <a href="#faq" class="section-title">Fact & Question</a> <br /><br /> - <div class="question" id="what_is_nyx"> - <span>What is Nyx?</span> - <div class="answer"> - <a href="images/screenshots/front_page.png"><img src="images/faq/front_page.png" alt="screenshot" /></a> - <p>Nyx is a command-line application for monitoring real time <a href="https://www.torproject.org/">Tor</a> status information. This includes bandwidth usage, logs, connections, configuration, and more.</p> - <p>As a curses interface Nyx is particularly well suited for ssh connections, tty terminals, and command-line aficionados.</p> - </div> - </div> - - <div class="question" id="why_is_it_called_nyx"> - <span>Why is it called Nyx?</span> - <div class="answer"> - <a href="http://fallenlights.net/"><img src="images/faq/shadowgirl.jpg" alt="greek goddess" title="Nyx by Shadowgirl, used with permission." /></a> - <p style="min-height: 340px">Simple - because the <a href="https://en.wikipedia.org/wiki/Nyx">Greek goddess of night</a> is short and memorable. Terminal applications are handiest when they're brief and easy to type. Top, ssh, scp - anything longer is just begging to be aliased down.</p> - </div> - </div> - - <div class="question" id="does_nyx_have_any_dependencies"> - <span>Does Nyx have any dependencies?</span> - <div class="answer"> - <p><b>Yes</b>, Nyx requires <a href="https://stem.torproject.org/>">Stem 1.4.5 or later</a>. - </div> - </div> - - <div class="question" id="what_python_versions_is_nyx_compatible_with"> - <span>What Python versions is Nyx compatible with?</span> - <div class="answer"> - <p>Nyx works with <b>Python 2.6 and greater</b>, including the Python 3.x series.</p> - </div> - </div> - - <div class="question" id="are_there_any_other_tor_uis"> - <span>Are there any other user interfaces for Tor?</span> - <div class="answer"> - <img src="images/faq/vidalia.jpg" alt="vidalia" /> - <p>Yes, though sadly this isn't a space that gets much attention.</p> - <p>For years <a href="https://en.wikipedia.org/wiki/Vidalia_%28software%29">Vidalia</a> was the default interface of Tor until it was replaced in 2013 by <a href="https://www.torproject.org/projects/torbrowser.html.en">Tor Browser</a>. Vidalia includes a launcher, settings editor, map, and more. <a href="https://sourceforge.net/projects/tork/">TorK</a> is similar, providing connection information as well but never reached the same level of prominence. Both interfaces are now unmaintained.</p> - <p>Smaller widgets include...</p> - - <ul> - <li><a href="https://gitorious.org/syboa/syboa">Syboa</a> - General interface</li> - <li><a href="https://github.com/neelchauhan/OnionLauncher">OnionLauncher</a> - Tor launcher</li> - <li><a href="https://github.com/neelchauhan/TorNova">TorNova</a> - Tor launcher</li> - <li><a href="https://github.com/skyguy/onionview">OnionView</a> - Circuit information</li> - <li><a href="https://git-tails.immerda.ch/onioncircuits/">OnionCircuits</a> - Circuit information</li> - <li><a href="https://github.com/Yawning/or-applet">or-applet</a> - Circuit information</li> - </ul> - - <p>If I missed any then please <a href="https://www.atagar.com/contact/">let me know</a>!</p> - </div> - </div> - - <div class="question" id="what_license_is_nyx_under"> - <span>What license is Nyx under?</span> - <div class="answer"> - <p>Nyx is under the <a href="https://www.gnu.org/licenses/gpl">GPLv3</a>.</p> - </div> - </div> + <ul class="questions"> + <li id="what_is_nyx"> + <span>What is Nyx?</span> + <div class="answer"> + <a href="images/screenshots/front_page.png"><img src="images/faq/front_page.png" alt="screenshot" /></a> + <p>Nyx is a command-line application for monitoring real time <a href="https://www.torproject.org/">Tor</a> status information. This includes bandwidth usage, logs, connections, configuration, and more.</p> + <p>As a curses interface Nyx is particularly well suited for ssh connections, tty terminals, and command-line aficionados.</p> + </div> + </li> + + <li id="why_is_it_called_nyx"> + <span>Why is it called Nyx?</span> + <div class="answer"> + <a href="http://fallenlights.net/"><img src="images/faq/shadowgirl.jpg" alt="greek goddess" title="Nyx by Shadowgirl, used with permission." /></a> + <p style="min-height: 340px">Simple - because the <a href="https://en.wikipedia.org/wiki/Nyx">Greek goddess of night</a> is short and memorable. Terminal applications are handiest when they're brief and easy to type. Top, ssh, scp - anything longer is just begging to be aliased down.</p> + </div> + </li> + + <li id="does_nyx_have_any_dependencies"> + <span>Does Nyx have any dependencies?</span> + <div class="answer"> + <p><b>Yes</b>, Nyx requires <a href="https://stem.torproject.org/>">Stem 1.4.5 or later</a>. + </div> + </li> + + <li id="what_python_versions_is_nyx_compatible_with"> + <span>What Python versions is Nyx compatible with?</span> + <div class="answer"> + <p>Nyx works with <b>Python 2.6 and greater</b>, including the Python 3.x series.</p> + </div> + </li> + + <li id="are_there_any_other_tor_uis"> + <span>Are there any other user interfaces for Tor?</span> + <div class="answer"> + <img src="images/faq/vidalia.jpg" alt="vidalia" /> + <p>Yes, though sadly this isn't a space that gets much attention.</p> + <p>For years <a href="https://en.wikipedia.org/wiki/Vidalia_%28software%29">Vidalia</a> was the default interface of Tor until it was replaced in 2013 by <a href="https://www.torproject.org/projects/torbrowser.html.en">Tor Browser</a>. Vidalia includes a launcher, settings editor, map, and more. <a href="https://sourceforge.net/projects/tork/">TorK</a> is similar, providing connection information as well but never reached the same level of prominence. Both interfaces are now unmaintained.</p> + <p>Smaller widgets include...</p> + + <ul> + <li><a href="https://gitorious.org/syboa/syboa">Syboa</a> - General interface</li> + <li><a href="https://github.com/neelchauhan/OnionLauncher">OnionLauncher</a> - Tor launcher</li> + <li><a href="https://github.com/neelchauhan/TorNova">TorNova</a> - Tor launcher</li> + <li><a href="https://github.com/skyguy/onionview">OnionView</a> - Circuit information</li> + <li><a href="https://git-tails.immerda.ch/onioncircuits/">OnionCircuits</a> - Circuit information</li> + <li><a href="https://github.com/Yawning/or-applet">or-applet</a> - Circuit information</li> + </ul> + + <p>If I missed any then please <a href="https://www.atagar.com/contact/">let me know</a>!</p> + </div> + </li> + + <li id="what_license_is_nyx_under"> + <span>What license is Nyx under?</span> + <div class="answer"> + <p>Nyx is under the <a href="https://www.gnu.org/licenses/gpl">GPLv3</a>.</p> + </div> + </li> + </ul> <div class="section"></div> <a href="#usage" class="section-title">Usage</a> <br /><br /> - <div class="question" id="will_exits_include_user_traffic"> - <span>When running an exit will I see people's traffic?</span> - <div class="answer"> - <p><b>No</b>. Potential client and exit connections are scrubbed of sensitive information. Be aware that it's highly discouraged (and possibly illegal) for relay operators to view this data, so please don't.</p> - </div> - </div> - - <div class="question" id="is_it_harmful_to_share_data"> - <span>Is it harmful to share the information provided by Nyx?</span> - <div class="answer"> - <p><b>Not really</b>, but show some moderation. Screenshots of Nyx are unlikely to do any harm but try to avoid exposing data en mass.</p> - </div> - </div> - - <div class="question" id="can_nyx_leak_data"> - <span>Is there any chance that nyx will leak data?</span> - <div class="answer"> - <p><b>No</b>. Nyx is a completely passive listener, fetching all information from either Tor or the local system.</p> - </div> - </div> - - <div class="question" id="why_dont_i_see_the_bandwith_graph"> - <span>Why don't I see the bandwidth graph?</span> - <div class="answer"> - <p>On some terminals such as Gentoo screen sessions appear to have a bug where highlighted spaces aren't shown. Try running...</p> - <pre>export TERM="rxvt-unicode"</pre> - </div> - </div> - - <div class="question" id="why_are_borders_broken"> - <span>Why are there borders like 'mwqqqqqqqqj'?</span> - <div class="answer"> - <p>If you're getting something that looks like...</p> - <a href="images/screenshots/acs_failure.png"><img src="images/faq/acs_failure.png" alt="acs display failure" /></a> - <p>... you are encountering a terminal bug where alternate character support (ACS) <a href="http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing">is unavailable</a>.</p> - <p>Unfortunately there doesn't seem to be a way for Nyx to automatically detect or correct this. To work around this you can set the following in your nyxrc to not use ACS borders...</p> - <pre>features.acsSupport false</pre> - </div> - </div> - - <div class="question" id="why_are_relay_details_missing"> - <span>Why are relay details for connections missing?</span> - <div class="answer"> - <p>Relays publish information about themselves in documents called <i>descriptors</i>. These documents are downloaded by Tor. New documents available on an hourly basis but Tor will only download them if it needs them, so the descriptors you have may be older.</p> - <p>Nyx's connections page use these descriptors to enrich connection information with data about the relay you're connected with. If Tor doesn't have this information the data may be stale or missing.</p> - <p><b>This is fine.</b> Descriptor information we use changes infrequently so even if they're a few hours old it won't matter. However, if you really need up-to-date information you can add the following to your torrc...</p> - - <pre># download new descriptors even if our cache is still valid + <ul class="questions"> + <li id="will_exits_include_user_traffic"> + <span>When running an exit will I see people's traffic?</span> + <div class="answer"> + <p><b>No</b>. Potential client and exit connections are scrubbed of sensitive information. Be aware that it's highly discouraged (and possibly illegal) for relay operators to view this data, so please don't.</p> + </div> + </li> + + <li id="is_it_harmful_to_share_data"> + <span>Is it harmful to share the information provided by Nyx?</span> + <div class="answer"> + <p><b>Not really</b>, but show some moderation. Screenshots of Nyx are unlikely to do any harm but try to avoid exposing data en mass.</p> + </div> + </li> + + <li id="can_nyx_leak_data"> + <span>Is there any chance that nyx will leak data?</span> + <div class="answer"> + <p><b>No</b>. Nyx is a completely passive listener, fetching all information from either Tor or the local system.</p> + </div> + </li> + + <li id="why_dont_i_see_the_bandwith_graph"> + <span>Why don't I see the bandwidth graph?</span> + <div class="answer"> + <p>On some terminals such as Gentoo screen sessions appear to have a bug where highlighted spaces aren't shown. Try running...</p> + <pre>export TERM="rxvt-unicode"</pre> + </div> + </li> + + <li id="why_are_borders_broken"> + <span>Why are there borders like 'mwqqqqqqqqj'?</span> + <div class="answer"> + <p>If you're getting something that looks like...</p> + <a href="images/screenshots/acs_failure.png"><img src="images/faq/acs_failure.png" alt="acs display failure" /></a> + <p>... you are encountering a terminal bug where alternate character support (ACS) <a href="http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing">is unavailable</a>.</p> + <p>Unfortunately there doesn't seem to be a way for Nyx to automatically detect or correct this. To work around this you can set the following in your nyxrc to not use ACS borders...</p> + <pre>features.acsSupport false</pre> + </div> + </li> + + <li id="why_are_relay_details_missing"> + <span>Why are relay details for connections missing?</span> + <div class="answer"> + <p>Relays publish information about themselves in documents called <i>descriptors</i>. These documents are downloaded by Tor. New documents available on an hourly basis but Tor will only download them if it needs them, so the descriptors you have may be older.</p> + <p>Nyx's connections page use these descriptors to enrich connection information with data about the relay you're connected with. If Tor doesn't have this information the data may be stale or missing.</p> + <p><b>This is fine.</b> Descriptor information we use changes infrequently so even if they're a few hours old it won't matter. However, if you really need up-to-date information you can add the following to your torrc...</p> + + <pre># download new descriptors even if our cache is still valid FetchDirInfoEarly 1 FetchDirInfoExtraEarly 1 FetchUselessDescriptors 1</pre> - </div> - </div> + </div> + </li> + </ul> <div class="section"></div> <a href="#development" class="section-title">Development</a> <br /><br /> - <div class="question" id="how_do_i_get_started"> - <span>How do I get started?</span> - <div class="answer"> - <p>The best way of getting involved with any project is to jump right in! Our <a href="http://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug tracker</a> lists several development tasks. In particular look for the 'easy' keyword when getting started. If you have any questions then I'm always more than happy to help! I'm <b>atagar</b> on <a href="http://www.oftc.net/">oftc</a> and also available <a href="https://www.atagar.com/contact/">via email</a>.</p> - <p>To start hacking on Nyx please do the following and don't hesitate to let me know if you get stuck or would like to discuss anything!</p> - - <ol> - <li>Clone our <a href="http://git-scm.com/">git</a> repository: <b>git clone https://git.torproject.org/nyx.git</b></li> - <li>Install the development version of <a href="https://stem.torproject.org/">Stem</a>: <b>git clone https://git.torproject.org/stem.git; cd stem; sudo python setup.py install</b>.</li> -#. Get our test dependencies: **sudo pip install mock pep8 pyflakes**. -#. Find a `bug or feature <https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs>`_ that sounds interesting. -#. When you have something that you would like to contribute back do the following... - - * If you don't already have a publicly accessible Nyx repository then set one up. `GitHub <https://github.com/>`_ in particular is great for this. - * File a `trac ticket <https://trac.torproject.org/projects/tor/newticket>`_, the only fields you'll need are... - - * Summary: short description of your change - * Description: longer description and a link to your repository with either the git commits or branch that has your change - * Type: 'defect' if this is a bug fix and 'enhancement' otherwise - * Priority: rough guess at the priority of your change - * Component: Core Tor / Nyx - - * I'll review the change and give suggestions. When we're both happy with it I'll push your change to the official repository. - </div> - </div> - - <div class="question" id="how_do_i_run_the_tests"> - <span>How do I run the tests?</span> - <div class="answer"> - <p>Nyx has unit tests, including tests that exercise our curses functionality. When you run the tests you may notice your console flicker as these are exercised.</p> - <p>If you have them installed we run <a href="https://launchpad.net/pyflakes">pyflakes</a> to do static error checking and <a href="http://pycodestyle.readthedocs.org/en/latest/">pycodestyle</a> for style checking as part of our tests.</p> - <p>Tests are run with...</p> - <pre>% run_tests.py</pre> - </div> - </div> - - <div class="question" id="what_is_the_copyright_for_patches"> - <span>What is the copyright for patches?</span> - <div class="answer"> - <p>Nyx is under the <a href="https://www.gnu.org/licenses/gpl">GPLv3</a> which is a fine license, but poses a bit of a problem for sharing code with our other projects (which are mostly BSD). To share code without needing to hunt down prior contributors we need Tor to have the copyright for the whole Nyx codebase. Presently the copyright of Nyx is jointly held by its main author (<a href="https://www.atagar.com/">Damian</a>) and the <a href="https://www.torproject.org/">Tor Project</a>. - <p>If you submit a substantial patch I'll ask if you're fine with it being in the public domain. This would mean that there are no legal restrictions for using your contribution, and hence won't pose a problem if we reuse Nyx code in other projects.</p> - </div> - </div> + <ul class="questions"> + <li id="how_do_i_get_started"> + <span>How do I get started?</span> + <div class="answer"> + <p>The best way of getting involved with any project is to jump right in! Our <a href="http://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug tracker</a> lists several development tasks. In particular look for the 'easy' keyword when getting started. If you have any questions then I'm always more than happy to help! I'm <b>atagar</b> on <a href="http://www.oftc.net/">oftc</a> and also available <a href="https://www.atagar.com/contact/">via email</a>.</p> + <p>To start hacking on Nyx please do the following and don't hesitate to let me know if you get stuck or would like to discuss anything!</p> + + <ol> + <li>Clone our <a href="http://git-scm.com/">git</a> repository: <b>git clone https://git.torproject.org/nyx.git</b></li> + <li>Install the development version of <a href="https://stem.torproject.org/">Stem</a>: <b>git clone https://git.torproject.org/stem.git; cd stem; sudo python setup.py install</b>.</li> + <li>Get our test dependencies: <b>sudo pip install mock pep8 pyflakes</b>.</li> + <li>Find a <a href="https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug or feature</a> that sounds interesting.</li> + <li>When you have something that you would like to contribute back do the following... + <ul> + <li>If you don't already have a publicly accessible Nyx repository then set one up. <a href="https://github.com/">GitHub</a> in particular is great for this.</li> + <li>File a <a href="https://trac.torproject.org/projects/tor/newticket">trac ticket</a>, the only fields you'll need are... + <ul> + <li><b>Summary</b>: short description of your change</li> + <li><b>Description</b>: longer description and a link to your repository with either the git commits or branch that has your change</li> + <li><b>Type</b>: 'defect' if this is a bug fix and 'enhancement' otherwise</li> + <li><b>Priority</b>: rough guess at the priority of your change</li> + <li><b>Component</b>: Core Tor / Nyx</li> + </ul> + </li> + <li>I'll review the change and give suggestions. When we're both happy with it I'll push your change to the official repository.</li> + </ul> + </li> + </ol> + </div> + </li> + + <li id="how_do_i_run_the_tests"> + <span>How do I run the tests?</span> + <div class="answer"> + <p>Nyx has unit tests, including tests that exercise our curses functionality. When you run the tests you may notice your console flicker as these are exercised.</p> + <p>If you have them installed we run <a href="https://launchpad.net/pyflakes">pyflakes</a> to do static error checking and <a href="http://pycodestyle.readthedocs.org/en/latest/">pycodestyle</a> for style checking as part of our tests.</p> + <p>Tests are run with...</p> + <pre>% run_tests.py</pre> + </div> + </li> + + <li id="what_is_the_copyright_for_patches"> + <span>What is the copyright for patches?</span> + <div class="answer"> + <p>Nyx is under the <a href="https://www.gnu.org/licenses/gpl">GPLv3</a> which is a fine license, but poses a bit of a problem for sharing code with our other projects (which are mostly BSD). To share code without needing to hunt down prior contributors we need Tor to have the copyright for the whole Nyx codebase. Presently the copyright of Nyx is jointly held by its main author (<a href="https://www.atagar.com/">Damian</a>) and the <a href="https://www.torproject.org/">Tor Project</a>. + <p>If you submit a substantial patch I'll ask if you're fine with it being in the public domain. This would mean that there are no legal restrictions for using your contribution, and hence won't pose a problem if we reuse Nyx code in other projects.</p> + </div> + </li> + </ul> </div> <div id="download" class="page"> @@ -353,7 +363,7 @@ FetchUselessDescriptors 1</pre> // show/hide for FAQ questions - $('.question > span').click(function() { + $('.questions > li > span').click(function() { var answer = $(this).parent().find('.answer'); if (answer.is('.open')) { diff --git a/web/styles.css b/web/styles.css index 617b74b..fb839ca 100644 --- a/web/styles.css +++ b/web/styles.css @@ -154,16 +154,21 @@ Front Page FAQ Page ============================================================*/ -.question { +.questions { + margin: 0px; + padding-left: 15px; +} + +.questions li { cursor: pointer; margin: 0px; padding: 0px 0px 5px 0px; text-align: left; } -.question span { - color: #523a17; - font-size: 24px; +.questions span { + color: #302000; + font-size: 18px; font-weight: bold; }

1 0

[nyx/master] Drop nyx screenshot 'What is nyx?' question
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit 4bbdfacd652ac427976558374e48c3aec99e7ced Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 29 16:33:57 2017 -0700 Drop nyx screenshot 'What is nyx?' question Having a small screenshot here really didn't add anything so dropping it. --- web/images/faq/front_page.png | Bin 42523 -> 0 bytes web/index.html | 1 - 2 files changed, 1 deletion(-) diff --git a/web/images/faq/front_page.png b/web/images/faq/front_page.png deleted file mode 100644 index 541ee61..0000000 Binary files a/web/images/faq/front_page.png and /dev/null differ diff --git a/web/index.html b/web/index.html index a9c0ca4..2b68571 100644 --- a/web/index.html +++ b/web/index.html @@ -95,7 +95,6 @@ <li id="what_is_nyx"> <span>What is Nyx?</span> <div class="answer"> - <a href="images/screenshots/front_page.png"><img src="images/faq/front_page.png" alt="screenshot" /></a> <p>Nyx is a command-line application for monitoring real time <a href="https://www.torproject.org/">Tor</a> status information. This includes bandwidth usage, logs, connections, configuration, and more.</p> <p>As a curses interface Nyx is particularly well suited for ssh connections, tty terminals, and command-line aficionados.</p> </div>

1 0

[nyx/master] Fill in FAQ content
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit 6f94c1178134a68da51d8165d5d81b4dfe61e2de Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 29 13:36:04 2017 -0700 Fill in FAQ content Styling isn't as I'd like yet. Just copying over the FAQ entries from our Sphinx page. --- web/images/faq/acs_failure.png | Bin 0 -> 161127 bytes web/images/faq/resources/vidalia_full.png | Bin 0 -> 44187 bytes web/images/faq/vidalia.jpg | Bin 0 -> 13695 bytes web/images/screenshots/acs_failure.png | Bin 0 -> 405426 bytes web/index.html | 150 +++++++++++++++++++++++++++++- 5 files changed, 149 insertions(+), 1 deletion(-) diff --git a/web/images/faq/acs_failure.png b/web/images/faq/acs_failure.png new file mode 100644 index 0000000..cd44aa8 Binary files /dev/null and b/web/images/faq/acs_failure.png differ diff --git a/web/images/faq/resources/vidalia_full.png b/web/images/faq/resources/vidalia_full.png new file mode 100644 index 0000000..3e13855 Binary files /dev/null and b/web/images/faq/resources/vidalia_full.png differ diff --git a/web/images/faq/vidalia.jpg b/web/images/faq/vidalia.jpg new file mode 100644 index 0000000..2350272 Binary files /dev/null and b/web/images/faq/vidalia.jpg differ diff --git a/web/images/screenshots/acs_failure.png b/web/images/screenshots/acs_failure.png new file mode 100644 index 0000000..48aff76 Binary files /dev/null and b/web/images/screenshots/acs_failure.png differ diff --git a/web/index.html b/web/index.html index 5da37bf..b73fc4c 100644 --- a/web/index.html +++ b/web/index.html @@ -89,7 +89,6 @@ <div id="faq" class="page"> <div class="section"></div> <a href="#faq" class="section-title">Fact & Question</a> - <br /><br /> <div class="question" id="what_is_nyx"> @@ -108,6 +107,155 @@ <p style="min-height: 340px">Simple - because the <a href="https://en.wikipedia.org/wiki/Nyx">Greek goddess of night</a> is short and memorable. Terminal applications are handiest when they're brief and easy to type. Top, ssh, scp - anything longer is just begging to be aliased down.</p> </div> </div> + + <div class="question" id="does_nyx_have_any_dependencies"> + <span>Does Nyx have any dependencies?</span> + <div class="answer"> + <p><b>Yes</b>, Nyx requires <a href="https://stem.torproject.org/>">Stem 1.4.5 or later</a>. + </div> + </div> + + <div class="question" id="what_python_versions_is_nyx_compatible_with"> + <span>What Python versions is Nyx compatible with?</span> + <div class="answer"> + <p>Nyx works with <b>Python 2.6 and greater</b>, including the Python 3.x series.</p> + </div> + </div> + + <div class="question" id="are_there_any_other_tor_uis"> + <span>Are there any other user interfaces for Tor?</span> + <div class="answer"> + <img src="images/faq/vidalia.jpg" alt="vidalia" /> + <p>Yes, though sadly this isn't a space that gets much attention.</p> + <p>For years <a href="https://en.wikipedia.org/wiki/Vidalia_%28software%29">Vidalia</a> was the default interface of Tor until it was replaced in 2013 by <a href="https://www.torproject.org/projects/torbrowser.html.en">Tor Browser</a>. Vidalia includes a launcher, settings editor, map, and more. <a href="https://sourceforge.net/projects/tork/">TorK</a> is similar, providing connection information as well but never reached the same level of prominence. Both interfaces are now unmaintained.</p> + <p>Smaller widgets include...</p> + + <ul> + <li><a href="https://gitorious.org/syboa/syboa">Syboa</a> - General interface</li> + <li><a href="https://github.com/neelchauhan/OnionLauncher">OnionLauncher</a> - Tor launcher</li> + <li><a href="https://github.com/neelchauhan/TorNova">TorNova</a> - Tor launcher</li> + <li><a href="https://github.com/skyguy/onionview">OnionView</a> - Circuit information</li> + <li><a href="https://git-tails.immerda.ch/onioncircuits/">OnionCircuits</a> - Circuit information</li> + <li><a href="https://github.com/Yawning/or-applet">or-applet</a> - Circuit information</li> + </ul> + + <p>If I missed any then please <a href="https://www.atagar.com/contact/">let me know</a>!</p> + </div> + </div> + + <div class="question" id="what_license_is_nyx_under"> + <span>What license is Nyx under?</span> + <div class="answer"> + <p>Nyx is under the <a href="https://www.gnu.org/licenses/gpl">GPLv3</a>.</p> + </div> + </div> + + <div class="section"></div> + <a href="#usage" class="section-title">Usage</a> + <br /><br /> + + <div class="question" id="will_exits_include_user_traffic"> + <span>When running an exit will I see people's traffic?</span> + <div class="answer"> + <p><b>No</b>. Potential client and exit connections are scrubbed of sensitive information. Be aware that it's highly discouraged (and possibly illegal) for relay operators to view this data, so please don't.</p> + </div> + </div> + + <div class="question" id="is_it_harmful_to_share_data"> + <span>Is it harmful to share the information provided by Nyx?</span> + <div class="answer"> + <p><b>Not really</b>, but show some moderation. Screenshots of Nyx are unlikely to do any harm but try to avoid exposing data en mass.</p> + </div> + </div> + + <div class="question" id="can_nyx_leak_data"> + <span>Is there any chance that nyx will leak data?</span> + <div class="answer"> + <p><b>No</b>. Nyx is a completely passive listener, fetching all information from either Tor or the local system.</p> + </div> + </div> + + <div class="question" id="why_dont_i_see_the_bandwith_graph"> + <span>Why don't I see the bandwidth graph?</span> + <div class="answer"> + <p>On some terminals such as Gentoo screen sessions appear to have a bug where highlighted spaces aren't shown. Try running...</p> + <pre>export TERM="rxvt-unicode"</pre> + </div> + </div> + + <div class="question" id="why_are_borders_broken"> + <span>Why are there borders like 'mwqqqqqqqqj'?</span> + <div class="answer"> + <p>If you're getting something that looks like...</p> + <a href="images/screenshots/acs_failure.png"><img src="images/faq/acs_failure.png" alt="acs display failure" /></a> + <p>... you are encountering a terminal bug where alternate character support (ACS) <a href="http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing">is unavailable</a>.</p> + <p>Unfortunately there doesn't seem to be a way for Nyx to automatically detect or correct this. To work around this you can set the following in your nyxrc to not use ACS borders...</p> + <pre>features.acsSupport false</pre> + </div> + </div> + + <div class="question" id="why_are_relay_details_missing"> + <span>Why are relay details for connections missing?</span> + <div class="answer"> + <p>Relays publish information about themselves in documents called <i>descriptors</i>. These documents are downloaded by Tor. New documents available on an hourly basis but Tor will only download them if it needs them, so the descriptors you have may be older.</p> + <p>Nyx's connections page use these descriptors to enrich connection information with data about the relay you're connected with. If Tor doesn't have this information the data may be stale or missing.</p> + <p><b>This is fine.</b> Descriptor information we use changes infrequently so even if they're a few hours old it won't matter. However, if you really need up-to-date information you can add the following to your torrc...</p> + + <pre># download new descriptors even if our cache is still valid + +FetchDirInfoEarly 1 +FetchDirInfoExtraEarly 1 +FetchUselessDescriptors 1</pre> + </div> + </div> + + <div class="section"></div> + <a href="#development" class="section-title">Development</a> + <br /><br /> + + <div class="question" id="how_do_i_get_started"> + <span>How do I get started?</span> + <div class="answer"> + <p>The best way of getting involved with any project is to jump right in! Our <a href="http://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug tracker</a> lists several development tasks. In particular look for the 'easy' keyword when getting started. If you have any questions then I'm always more than happy to help! I'm <b>atagar</b> on <a href="http://www.oftc.net/">oftc</a> and also available <a href="https://www.atagar.com/contact/">via email</a>.</p> + <p>To start hacking on Nyx please do the following and don't hesitate to let me know if you get stuck or would like to discuss anything!</p> + + <ol> + <li>Clone our <a href="http://git-scm.com/">git</a> repository: <b>git clone https://git.torproject.org/nyx.git</b></li> + <li>Install the development version of <a href="https://stem.torproject.org/">Stem</a>: <b>git clone https://git.torproject.org/stem.git; cd stem; sudo python setup.py install</b>.</li> +#. Get our test dependencies: **sudo pip install mock pep8 pyflakes**. +#. Find a `bug or feature <https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs>`_ that sounds interesting. +#. When you have something that you would like to contribute back do the following... + + * If you don't already have a publicly accessible Nyx repository then set one up. `GitHub <https://github.com/>`_ in particular is great for this. + * File a `trac ticket <https://trac.torproject.org/projects/tor/newticket>`_, the only fields you'll need are... + + * Summary: short description of your change + * Description: longer description and a link to your repository with either the git commits or branch that has your change + * Type: 'defect' if this is a bug fix and 'enhancement' otherwise + * Priority: rough guess at the priority of your change + * Component: Core Tor / Nyx + + * I'll review the change and give suggestions. When we're both happy with it I'll push your change to the official repository. + </div> + </div> + + <div class="question" id="how_do_i_run_the_tests"> + <span>How do I run the tests?</span> + <div class="answer"> + <p>Nyx has unit tests, including tests that exercise our curses functionality. When you run the tests you may notice your console flicker as these are exercised.</p> + <p>If you have them installed we run <a href="https://launchpad.net/pyflakes">pyflakes</a> to do static error checking and <a href="http://pycodestyle.readthedocs.org/en/latest/">pycodestyle</a> for style checking as part of our tests.</p> + <p>Tests are run with...</p> + <pre>% run_tests.py</pre> + </div> + </div> + + <div class="question" id="what_is_the_copyright_for_patches"> + <span>What is the copyright for patches?</span> + <div class="answer"> + <p>Nyx is under the <a href="https://www.gnu.org/licenses/gpl">GPLv3</a> which is a fine license, but poses a bit of a problem for sharing code with our other projects (which are mostly BSD). To share code without needing to hunt down prior contributors we need Tor to have the copyright for the whole Nyx codebase. Presently the copyright of Nyx is jointly held by its main author (<a href="https://www.atagar.com/">Damian</a>) and the <a href="https://www.torproject.org/">Tor Project</a>. + <p>If you submit a substantial patch I'll ask if you're fine with it being in the public domain. This would mean that there are no legal restrictions for using your contribution, and hence won't pose a problem if we reuse Nyx code in other projects.</p> + </div> + </div> </div> <div id="download" class="page">

1 0

[nyx/master] Expand anchored FAQ entries
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit 5d8bda07ca17afd6569fc7d311593ed8f6048b4c Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jul 31 17:52:29 2017 -0700 Expand anchored FAQ entries --- web/index.html | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/web/index.html b/web/index.html index 5ec9ea8..8cf0d11 100644 --- a/web/index.html +++ b/web/index.html @@ -351,25 +351,11 @@ sudo python setup.py install</pre><br /></li> <script> $(function() { - // when provided an anchor select the tab it resides within - - var anchor = window.location.hash; $(".tabs").tabs(".page", { history: true }); - if (anchor) { - $(".page").each(function () { - if ($(this).find(anchor).length) { - $(".tabs").data("tabs").click(this.id); - document.getElementById(anchor.substr(1)).scrollIntoView(); - } - }); - } - // show/hide for FAQ questions - $('.questions > li > span').click(function() { - var answer = $(this).parent().find('.answer'); - + var toggleFaq = function(answer) { if (answer.is('.open')) { answer.animate({'height': '0'}, 100); answer.removeClass('open'); @@ -385,7 +371,29 @@ sudo python setup.py install</pre><br /></li> answer.animate({'height': newHeight}, 100); answer.addClass('open'); } + } + + $('.questions > li > span').click(function() { + toggleFaq($(this).parent().find('.answer')); }); + + // when provided an anchor select the tab it resides within + + var anchor = window.location.hash; + + if (anchor) { + $(".page").each(function () { + if ($(this).find(anchor).length) { + $(".tabs").data("tabs").click(this.id); + + if (this.id == "faq" && anchor != "#faq") { + toggleFaq($(anchor + " > .answer")); + } + + document.getElementById(anchor.substr(1)).scrollIntoView(); + } + }); + } }); </script> </body>

1 0

[nyx/master] Describe our versioning scheme
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit 5eda50d2b3815a61eb4ce32ab3e4196655b17580 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 4 02:11:08 2017 -0700 Describe our versioning scheme Largely copied from Stem. We use symantic versioning, with the additional caveat that the 1.x series didn't use a formal scheme. --- web/index.html | 29 ++++++++++++++++++++++++++++- web/styles.css | 4 ++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/web/index.html b/web/index.html index 281aecd..a47629a 100644 --- a/web/index.html +++ b/web/index.html @@ -19,6 +19,10 @@ #faq_section { display: none; } + +#changelog_section { + display: none; +} </style> </noscript> </head> @@ -198,7 +202,7 @@ </li> </ul> - <div class="faq-section" style="padding-top: 35px;"></div> + <div class="faq-section"></div> <a href="#usage" class="section-title">Usage</a> <br /><br /> @@ -397,6 +401,29 @@ sudo python setup.py install</pre><br /></li> </div> <div id="changelog_section" class="page"> + <div class="section"></div> + <a href="#changelog" class="section-title">Change Log</a> + + <p>The following is a log of all user-facing changes to Nyx, both released and unreleased. For a monthly report on work being done see my <a href="http://blog.atagar.com/">development log</a>.</p> + + <ul> + <li><b><a href="#versioning">Versioning</a></b></li> + <li><b><a href="#unreleased">Unreleased</a></b></li> + <li><b><a href="#version_1">Version 1.x</a></b></li> + </ul> + + <div id="versioning" class="section" style="padding-top: 15px"></div> + <a href="#versioning" class="section-title">Versioning</a> + + <p>As of the 2.x release Nyx uses <a href="http://semver.org/">semantic versioning</a>, which means that <b>versions consist of three numbers</b> (such as '<b>1.2.4</b>'). These are used to convey the kind of backward compatibility a release has...</p> + + <ul> + <li><p>The first value is the <b>major version</b>. This changes infrequently, and indicates that backward incompatible changes have been made (such as the removal of deprecated functions).</p></li> + <li><p>The second value is the <b>minor version</b>. This is the most common kind of release, and denotes that the improvements are backward compatible.</p></li> + <li><p>The third value is the <b>patch version</b>. When a Nyx release has a major issue another release is made which fixes just that problem. These do not contain substantial improvements or new features. This value is sometimes left off to indicate all releases with a given major/minor version.</p></li> + </ul> + + <p>Prior to version 2.x nyx did not follow any particular versioning scheme.</p> </div> <script> diff --git a/web/styles.css b/web/styles.css index 88aac94..26424c4 100644 --- a/web/styles.css +++ b/web/styles.css @@ -107,6 +107,10 @@ Common Page Attributes text-align: justify; } +.page ul { + text-align: justify; +} + .section { border-bottom: 1px solid #856231; margin-bottom: -16px;

1 0

[nyx/master] Keep focus at top for page anchors
by atagar＠torproject.org 05 Aug '17

05 Aug '17

commit 8c721398b4d64fe20ab9a924966642ed2613ebb5 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Aug 2 10:27:47 2017 -0700 Keep focus at top for page anchors Our nav links work in different ways based on if the visitor has javascript or not. * When the visitor has JS the nav link targets determine the anchor that appears in the url bar, but does *not* care about the id in the page div. For JS users using short names (#home, #faq, or #download). These mismatch the div ids so focus doesn't drop from the top of the page. * When visitors lack JS all pages are visible and the nav links drop focus to the respective page div. In this case the link needs to match the div id, and uses longer ids (#home_section or #download_section). --- web/index.html | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/web/index.html b/web/index.html index 021a074..347156a 100644 --- a/web/index.html +++ b/web/index.html @@ -10,14 +10,13 @@  <script src="jquery.tools.min.js"></script> -  <noscript> <style> -#t2 { +#js_nav { display: none; } -#faq { +#faq_section { display: none; } </style> @@ -29,16 +28,24 @@ <div class="header-body"> <span id="logo"></span> <div class="nav"> - <ul class="tabs nav"> + <ul class="tabs nav" id="js_nav"> <li><a id="t1" href="#home">What Is It?</a></li> <li><a id="t2" href="#faq">FAQ</a></li> <li><a id="t3" href="#download">Download</a></li> </ul> + + <noscript> +  + <ul class="tabs nav"> + <li><a href="#home_section">What Is It?</a></li> + <li><a href="#download_section">Download</a></li> + </ul> + </noscript> </div> </div> </div> - <div id="home" class="page"> + <div id="home_section" class="page"> <div id="welcome" class="section"></div> <a href="#welcome" class="section-title">Welcome to Nyx</a> @@ -99,7 +106,7 @@ </div> </div> - <div id="faq" class="page"> + <div id="faq_section" class="page"> <div class="section"></div> <a href="#faq" class="section-title">Fact & Question</a> <br /><br /> @@ -311,7 +318,7 @@ sudo python setup.py install</pre><br /></li> </ul> </div> - <div id="download" class="page"> + <div id="download_section" class="page"> <div class="section"></div> <a href="#download" class="section-title">Download</a>

1 0