Opened 5 months ago

Last modified 6 days ago

#2298 accepted defect

Translate console help page

Reported by: zzz Owned by: zzz
Priority: minor Milestone: 0.9.39
Component: apps/console Version: 0.9.36
Keywords: Cc: sadie, slumlord
Parent Tickets: #2330

Description

ref: #2239 #1401
We can now do the same with the help page at /help.

Currently split up into 8 files (1 jsp and 7 jsi) but displayed to the user as one. There are 7 tabs at the top, linking to anchors for 6 parts and the change log.

> wc help*
   44   582  4903 help-advancedsettings.jsi
   33   284  2335 help-configuration.jsi
   80  1383 11075 help-faq.jsi
    9    58   637 help.jsi
   47   160  2219 help.jsp
   34   354  3350 help-legal.jsi
   72   742  5861 help-reachability.jsi
  111  1480 10088 help-sidebar.jsi
  430  5043 40468 total

We should be able to do this for 37. It's similar to what we did for the eepsite help and the console home page, but need to figure out the structure first. Do we keep it all as one page or split it up... if so, how?

After those decisions, we can rewrite/reformat for translatability.

cc: sadie and slumlord for general guidance

Subtickets (add)

Change History (6)

comment:1 Changed 4 months ago by slumlord

I am going over the various files that make up the /help page and making the following changes:

  • Each sentence on 1 line
  • Adding in a missing space after a period
  • Remove italics due to readability issues with certain scripts (e.g. Chinese, Arabic)

Notes:

  • help-sidebar.jsi:
    • The following portion is commented out. If not required - remove?
      <%                                                                                                                                                                                                                 
      /*                                                                                                                                                                                                                 
      <li>                                                                                                                                                                                                               
      <b>Reachability:</b>                                                                                                                                                                                               
      The router's view of whether it can be contacted by other routers. See <a href="#confignet">below</a> for more information.</li>                                                                                   
      */                                                                                                                                                                                                                 %> 
      
    • Remove link to speedtest.net? (I have changed it to https://speedtest.net for now)
    • Another commented-out section:
      <%                                                                                                                                                                                                                 
      /*                                                                                                                                                                                                                 
      <li>                                                                                                                                                                                                               
      <b>Tunnel lag:</b> This is the round trip time for a tunnel test, which sends a single message out a client tunnel and in an exploratory tunnel, or vice versa. It should usually be less than 5 seconds. If it is consistently higher than that, your computer is very slow, or you should adjust your bandwidth limits, or there are network problems. Problems may be indicated on the <a href="logs">Logs page</a>. <a href="configstats#tunnel.testSuccessTime">[Enable graphing]</a> (tunnel.testSuccessTime).
      </li>                                                                                                                                                                                                              
                                                                                                                                                                                                                         
      <li>                                                                                                                                                                                                               
      <b>Handle backlog:</b> This is the number of pending requests from other routers to build a participating tunnel through your router. It should usually be close to zero. If it is consistently high, your computer is too slow, and you should reduce your share bandwidth limits.</li>                                                       
      */                                                                                                                                                                                                                 
      %>
      
  • help-configuration.jsi: did not touch this file, seems to have translation-related stuff in there already
  • help-reachability.jsi: did not touch this file, seems to have translation-related stuff in there already

Changes are in dba1ad61c390f95055923ae1fb35e60552f617c6

comment:2 Changed 4 months ago by zzz

  • Milestone changed from 0.9.37 to 0.9.38
  • Status changed from new to accepted

re: configuration and reachability, that's really strange, I didn't realize those files were tagged. From looking at the mtn logs, those strings were previously tagged when they were in /confignet, so they remain tagged when str4d/drz moved them to help-xxx

here's some relevant checkins:

Revision: b324a96172089b549e53fb1c0c2a01807fe64699
Author:   str4d@mail.i2p
Date:     10/31/2013
Branch:   i2p.i2p

Split routerconsole help into several files (no frontend change)
The old full-page translations of help.jsp are deprecated. The help text will
be tagged for translation on Transifex.

------

Revision: f253b24b4a6d5c841605792653ed57344dade6c4
Author:   str4d@mail.i2p
Date:     05/01/2016
Branch:   i2p.i2p.str4d.ui

Collate help topics under /help

------

Revision: 645f60a4d23af4116ae660b09dfff32d19a65c32
Author:   str4d@mail.i2p
Date:     05/08/2016
Branch:   i2p.i2p.str4d.ui

Missing files from revision f253b24b4a6d5c841605792653ed57344dade6c4

so note that the plan from 2013 to tag everything never happened., but those strings in configuration and reachability were previously tagged when they were in a configxxx.jsp and so the tags stayed when moved to a help jsi.

So yeah, don't touch the tagged strings for 37. We're going to have only cleanups for 37 because we're pulling in 37 and there's no time left. Keep going with those. The restructuring, including tagging everything or uploading it to transifex in html format, will wait to 38. How to translate it will depend on how we structure it, hopefully we'll get some guidance from sadie soon, maybe on mattermost.

comment:3 Changed 4 months ago by sadie

Early thoughts on redesign would be to mimic the /home page - use icons, a brief description per help category, and link to a new page. Let's keep consistency re is it "summary" bar or "sidebar.

Here are some new icon ideas - source is The Noun Project https://thenounproject.com/ for inspiration. Would like to move to simple/minimal icons.

"Summary Bar/ Network Status"
https://thenounproject.com/search/?q=network&i=1938493

"Reachability"
https://thenounproject.com/search/?q=reachable&i=676345

"Advanced Settings"
https://thenounproject.com/search/?q=change%20log&i=365219

"FAQ"
https://thenounproject.com/search/?q=faq%20sign&i=1937965

"Legal" ( lets get rid of "stuff")
https://thenounproject.com/search/?q=legal%20agreement&i=1333674

"Change log"
https://thenounproject.com/search/?q=change%20log&i=365219

Last edited 4 months ago by sadie (previous) (diff)

comment:4 Changed 4 months ago by zzz

  • Parent Tickets set to 2330

comment:5 Changed 6 weeks ago by zzz

  • Milestone changed from 0.9.38 to 0.9.39

Moved to .39 per sadie

comment:6 Changed 6 days ago by sadie

moving this to .40 or beyond for the moment. We can add this as an agenda item in our weekly design meetings post .38 to discuss solutions.

Note: See TracTickets for help on using tickets.