phillip/ingress-intel-total-conversion
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

split up userguide for sidebar section

Browse Source
This commit is contained in:
Stefan Breunig 2013-02-22 09:48:26 +01:00
parent de20ac0d32
commit e78de477a5
1 changed files with 43 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
USERGUIDE.md
View File

@ -47,7 +47,7 @@ Map Display
You can customize many aspects of how the map is rendered in the layer chooser. The layer chooser is available from the icon in the top right corner, left of the sidebar. You can customize many aspects of how the map is rendered in the layer chooser. The layer chooser is available from the icon in the top right corner, left of the sidebar.
** Background / Street Map / Base Layer**: **Background / Street Map / Base Layer:**
All these refer to the same thing. The base layer is stored across sessions. The default one uses OpenStreetMap data with a style that resembles the default Ingress one. There are other styles available. All these refer to the same thing. The base layer is stored across sessions. The default one uses OpenStreetMap data with a style that resembles the default Ingress one. There are other styles available.
The layers from Google Maps are available as well. Google requires that their maps are only displayed with their tools. Therefore they cannot be as tightly integrated as the OpenStreetMap ones. That’s the reason why they lag behind. The layers from Google Maps are available as well. Google requires that their maps are only displayed with their tools. Therefore they cannot be as tightly integrated as the OpenStreetMap ones. That’s the reason why they lag behind.
@ -87,41 +87,61 @@ Sidebar
The sidebar is mainly used to show game stats and portal details. However, it also allows you to perform certain actions. The sidebar is mainly used to show game stats and portal details. However, it also allows you to perform certain actions.
**General usage:** ### General usage:
- single click a portal to show details about it in the sidebar - single click a portal to show details about it in the sidebar
- the portal information is updated automatically, as long as the selected portal is kept in view and you do not zoom out too much. - the portal information is updated automatically, as long as the selected portal is kept in view and you do not zoom out too much.
- the sidebar may be collapsed. Click the triangle button that stands out at the left hand side. - the sidebar may be collapsed. Click the triangle button that stands out at the left hand side.
- the sidebar **can be scrolled** if your screen is too small. Use your scroll wheel. - the sidebar **can be scrolled** if your screen is too small. Use your scroll wheel.
- almost anything has tooltips. See also [General usage](#general-usage) above. - almost anything has tooltips. See [General usage](#general-usage) above.
**Details:** ### Details:
Starting from the top, the sidebar shows this information: Starting from the top, the sidebar shows this information:
#### logged in user, global MU, search
- Details about you, the logged in user. This is only updated if you reload the page. This is a limitation of Ingress, not IITC. - Details about you, the logged in user. This is only updated if you reload the page. This is a limitation of Ingress, not IITC.
- it shows your current level followed by your nick - it shows your current level followed by your nick
- to the right, it shows to percentages. The upper one, e.g. “XM: 37%” tells you how much your XM bar is filled. The lower one, e.g. “level: 37%“ tells you that you have gathered 37% of the AP required for the next level. It shows “max level” if you have reached max level. - to the right, it shows to percentages. The upper one, e.g. “XM: 37%” tells you how much your XM bar is filled. The lower one, e.g. “level: 37%“ tells you that you have gathered 37% of the AP required for the next level. It shows “max level” if you have reached max level.
- the tooltip mainly shows you absolute numbers instead of percentages. It also shows how much invites you have. - the tooltip mainly shows you absolute numbers instead of percentages. It also shows how much invites you have.
- The next bar is a visual representation of global MindUnits (MU) per faction. It is updated every now and then. The tooltip shows the absolute MU count per faction. - The next bar is a visual representation of global MindUnits (MU) per faction. It is updated every now and then. The tooltip shows the absolute MU count per faction.
- Search Location: You can search for continents, countries, cities or street addresses. If there is at least one result your are taken to the most likely immediately. There is no feedback if the entered location was not found. Rule of thumb: if it takes longer than three seconds, try again. [Read about supported formats in the user guide for this service](https://wiki.openstreetmap.org/wiki/Nominatim). - Search Location: You can search for continents, countries, cities or street addresses. If there is at least one result your are taken to the most likely immediately. There is no feedback if the entered location was not found. Rule of thumb: if it takes longer than three seconds, try again. [Read about supported formats in the user guide for this service](https://wiki.openstreetmap.org/wiki/Nominatim).
- Portal details.
- Portal name, may be abbreviated by the server if it’s too long.
- Portal image. Can be clicked to show the full image. The tooltip shows street address and postal code for the portal. It may also show attribution data for the portal image, if available. #### Portal details.
- Portal level is located in the upper right corner and may overlay the image. - Portal name, may be abbreviated by the server if it’s too long.
- Portal mods are shown in right below the portal image. An empty box means that this slot is free and no mod is installed. Otherwise the name of the installed mod is displayed. The color depends on the rare-ness of the mod. Each slot has its own tooltip that shows mod specific details and who installed it. - Portal image. Can be clicked to show the full image. The tooltip shows street address and postal code for the portal. It may also show attribution data for the portal image, if available.
- “Random Details” are displayed in four columns. The outer ones show the data while the inner ones are the titles. - Portal level is located in the upper right corner and may overlay the image.
- owner: who deployed the first resonator after it has been neutral/unclaimed.
- since: when was the first resonator deployed after it has been neutral/unclaimed. - Portal mods are shown in right below the portal image. An empty box means that this slot is free and no mod is installed. Otherwise the name of the installed mod is displayed. The color depends on the rare-ness of the mod. Each slot has its own tooltip that shows mod specific details and who installed it.
- range: shows how far links made from this portal can be. Click on the value to zoom out to link range. The red circle shows how far links may reach.
- energy: shows current and maximum energy if fully charged. The tooltip contains the exact numbers. ##### “random details”
- links: shows incoming and outgoing links. The tooltip explains the icons. “Random Details” are displayed in four columns. The outer ones show the data while the inner ones are the titles.
- reso dist: shows the average distance the resonators have to the portal.
- fields: how many fields are connected to this portal - owner: who deployed the first resonator after it has been neutral/unclaimed.
- AP Gain: estimate of how much AP you gain if you take down this portal and deploy resonators of your own faction. Tooltip breaks this number down into parts. - since: when was the first resonator deployed after it has been neutral/unclaimed.
- Resonators view. The nickname to the left and right show who deployed this resonator. The bars in the middle indicate the charge of each resonator. The color depends on the level, which is also shown in the bar. The tooltip repeats some of that data along with other details. The top left resonator is the north one, top right is north east and so on. They are roughly ordered like they appear on a normal map. - range: shows how far links made from this portal can be. Click on the value to zoom out to link range. The red circle shows how far links may reach.
- Some links: - energy: shows current and maximum energy if fully charged. The tooltip contains the exact numbers.
- Portal link: use it show others a portal. IITC users will automatically zoomed to the location and shown portal details as soon as they’re available. Vanilla map users will only be zoomed to location. - links: shows incoming and outgoing links. The tooltip explains the icons.
- Report issue: redirects you to Niantic report issue page. Allows you to copy all required information before going there. - reso dist: shows the average distance the resonators have to the portal.
- GMaps: shows you the portal’s location in Google Maps for routing and similar purposes. - fields: how many fields are connected to this portal
- AP Gain: estimate of how much AP you gain if you take down this portal and deploy resonators of your own faction. Tooltip breaks this number down into parts.
##### Resonators
The nickname to the left and right show who deployed this resonator. The bars in the middle indicate the charge of each resonator. The color depends on the level, which is also shown in the bar. The tooltip repeats some of that data along with other details. The top left resonator is the north one, top right is north east and so on. They are roughly ordered like they appear on a normal map:
```
N NE
NW E
W SE
SW S
```
#### portal related links
- Portal link: use it show others a portal. IITC users will automatically zoomed to the location and shown portal details as soon as they’re available. Vanilla map users will only be zoomed to location.
- Report issue: redirects you to Niantic report issue page. Allows you to copy all required information before going there.
- GMaps: shows you the portal’s location in Google Maps for routing and similar purposes.
#### Redeeming, General Links and functions
- Redeem code: allows you to redeem codes to receive goodies. If you copied them from the Internet, they are probably invalid already. - Redeem code: allows you to redeem codes to receive goodies. If you copied them from the Internet, they are probably invalid already.
- Toolbox: plugins may add links here. The default ones are: - Toolbox: plugins may add links here. The default ones are:
- permalink. use it to show your current map view to others. Does not select a portal. Works with the normal intel map, too. - permalink. use it to show your current map view to others. Does not select a portal. Works with the normal intel map, too.