View source for View it! Tool

{{ptag|View-it!}}
{{:View it! Tool/Header}}
[[File:View it! Tool.png|right|100px]]
'''View it!''' is a suite of tools that display all relevant media from Wikimedia Commons depicting—or otherwise related to—the article one is reading. It officially launched on January 12, 2023 with a web app, two user scripts, and an API.
{{2024 Coolest tool award|View It!|Newcomer}}
{{clear}}

== Description ==
[[File:View it! Tool on Wikipedia as of 2024.jpg|thumb|right|View it! gallery on a Wikipedia article]]
View it! is a suite of tools to help editors and readers discover freely licensed media, enabled by [[:commons:Commons:Structured data|structured data on Commons]]. While the number of images displayed in a Wikipedia article is finite and highly curated by editors, View it! allows readers to easily access the full catalog of images available on Wikimedia Commons, and help editors easily add relevant media to an article.

The Toolforge source code is published [https://gitlab.wikimedia.org/kevinpayravi/view-it here] and we have a [[View it! Tool/Changelog|changelog]] available of all tool and script changes.
{{clear}}

<div style="width: 90%; margin: 0 auto; background-color: #005799; padding: 10px; border-radius: 10px; text-align: center;">
<span style="font-size: 1.5em; color: white;">'''View it! Suite'''</span>
<div style="display: flex; flex-wrap: wrap; justify-content: center;">
<div style="flex: 1 1 calc(33.333% - 20px); max-width: 150px; margin: 10px; background-color: #fff; border: 2px solid #005799; border-radius: 10px; text-align: center; padding: 10px;">
[[File:Museum - The Noun Project.svg|100px|alt=|link=]]

<span style="font-size: 1.2em;">[https://view-it.toolforge.org/ Search Portal]</span><br />for querying images by Q-item
</div>
<div style="flex: 1 1 calc(33.333% - 20px); max-width: 150px; margin: 10px; background-color: #fff; border: 2px solid #005799; border-radius: 10px; text-align: center; padding: 10px;">
[[File:Bank statement (77090) - The Noun Project.svg|100px|alt=|link=]]

<span style="font-size: 1.2em;">User script</span><br/>for embedding galleries on articles
</div>
<div style="flex: 1 1 calc(33.333% - 20px); max-width: 150px; margin: 10px; background-color: #fff; border: 2px solid #005799; border-radius: 10px; text-align: center; padding: 10px;">
[[File:API - The Noun Project.svg|100px|alt=|link=]]

<span style="font-size: 1.2em;">API</span><br/>for building your own tools
</div>
</div>
</div>

== Features ==
View it! provides two experiences to explore and view media via structured data on Commons:
* On Toolforge ([https://view-it.toolforge.org/ view-it.toolforge.org]), where users can query for specific Wikidata items and use advanced search to search via free text, as well as filter by assessment and resolution. Media can be queried by {{property|180}}, {{property|921}}, {{property|170}}, and {{property|373}}. 
* A user script that embeds a gallery within articles across Wikimedia projects, including Wikipedia, Wikidata, and Wikispecies, and Wikivoyage.

When using the user scripts, users are able to easily add an image to an article they are editing. While in either visual or source editor, users can copy the image wikitext code by clicking the copy icon on any image in the gallery and paste it into the article they're working on. When using View it! on Wikidata, users can also easily assign an image as an item's {{property|18}} statement if one doesn't already exist. 

[[File:View it! copy function, 2024.jpg|thumb|right|View it! copy function, 2024]]

== Script installation ==
View it! embeds a gallery at the top of articles so that images are readily and easily viewable. It includes the ability to copy image wikitext code, and allows users to add {{property|18}} statements on Wikidata items in one-click.

=== Across projects ===
To enable View it! on all Wikimedia wikis:

# Visit your global.js page on Meta: [[Special:MyPage/global.js|User:<YourUserName>/global.js]]
# Copy in the code
#* <code><nowiki>{{subst:view it}}</nowiki></code>
# Click "Publish changes"

''Please note you may see an error message reading:'' The document contains errors. Are you sure you want to publish? ''when you click publish - this is a bug, and it will still work.''

<gallery mode="packed">
File:Meta global.js before script.jpg|thumb|Go to your User global.js page on Meta
File:View it! script copied in globaljs.jpg|thumb|View it! script copied in global.js
File:Meta global.js after copying in View it! script.jpg|thumb|Meta global.js after saving View it! script
</gallery>

=== For specific projects ===
If you wish to only enable View it! on your local project: 

# Visit your common.js page: "<code>Special:MyPage/common.js</code>" on your wiki of choice.
# Copy in the code
#* For full View it!:
#*: <code><nowiki>mw.loader.load( '//meta.wikimedia.org/w/index.php?title=User:SuperHamster/view-it-full.js&action=raw&ctype=text/javascript' ); // Backlink: [[meta:User:SuperHamster/view-it-full.js]]</nowiki></code>
#* For View it! lite:
#*: <code><nowiki>mw.loader.load( '//meta.wikimedia.org/w/index.php?title=User:SuperHamster/view-it.js&action=raw&ctype=text/javascript' ); // Backlink: [[meta:User:SuperHamster/view-it.js]]</nowiki></code>
#Click "Publish changes"

<gallery mode="packed">
File:Screenshot of Common.js page.jpg|thumb|Screenshot of Common.js page - User:JamieF already has other scripts in use
File:View it! script copied to commonjs.jpg|thumb|View it! script copied to common.js
File:Screenshot of Common.js View it! tool input.jpg|thumb|Screenshot of Common.js after saving View it! script
</gallery>

===After installation===
Once installed you will see a "View" button between "Read" and "Edit" on the right that is connected to Wikidata/Structured data. The gallery will show 20 images at a time that can be scrolled through (left to right). When the 4 blue, downward facing arrows are clicked, users are shown all 20 images at one time. If there are more than 20 images, a previous page and next page button will appear, so all images may be paged through. Additionally, there is a button sayng "View all x images" with the number of images available. 
<gallery mode="packed">
File:View it! button 2024.png|thumb|View it! button after installation
File:Open View it! on Wikipedia.png|thumb|View it! gallery opened on Wikipedia with navigation buttons]]
</gallery>

View it! will also work on other Wikipedia projects:

<gallery mode="packed">
File:View it! on WikiSpecies.jpg|thumb|View it! on WikiSpecies
File:View it! on WikiVoyage.jpg|thumb|View it! on WikiVoyage
File:View_it!_on_Wikidata.jpg|thumb|View it! on Wikidata
</gallery>

== Localization ==

View it! has multilingual support! Add missing languages by expanding the [[View_it!_Tool/localization_instructions|localization instructions]] below. You can also make edits to existing languages.

{{collapse|{{:View_it!_Tool/localization_instructions}} | Expand for localization instructions}}

== API ==
View it! also includes its own API that serves as an intermediary service in front of the standard Commons Structure Data API, to simplify querying.

To query for images for a particular Wikidata item, like [[:wikidata:Q2|Q2]] for Earth:
:<code>https://view-it.toolforge.org/api/Q2</code>

Each response includes the <code>total</code> image count, and an array of up to 20 image <code>results</code> that include a link to the file page, a thumbnail, the file title, and then width and height of the thumbnail.

To retrieve images beyond the initial 20 results, you can use the <code>offset</code> parameter:
:<code>https://view-it.toolforge.org/api/Q2?offset=20</code>

By default, View it! will search for images that "depict or link from" the specified Q-item. You can choose to search against other Wikidata properties: Depicts (P180), Main subject (P921), Created by (P170), or Commons category (P373).
:<code>https://view-it.toolforge.org/api/Q2?property=depicts</code>
:<code>https://view-it.toolforge.org/api/Q2?property=main</code>
:<code>https://view-it.toolforge.org/api/Q2?property=creator</code>
:<code>https://view-it.toolforge.org/api/Q2?property=category</code>

To filter by <code>assessment</code> (<code>featured</code>, <code>quality</code>, <code>valued</code>):
:<code>https://view-it.toolforge.org/api/Q2?assessment=featured</code>

To filter by <code>resolution</code> (<code>small</code> [<500px], <code>medium</code>, <code>large</code> [>1000px]):
:<code>https://view-it.toolforge.org/api/Q2?resolution=high</code>

To search with free text:
:<code>https://view-it.toolforge.org/api/Q2?freetext=text</code>

== Update sign up ==
[[View it! Tool/Monthly update archive|Update archive]]

Please sign up if you're interested in receiving periodic updates about View it! tool - including the launch date and listening/comment sessions.

<div style="{{{style|}}}"><inputbox>
type        = comment
default     = {{FULLPAGENAME}}/Update sign up
preload     = {{#switch:{{{list|{{{type|}}}}}}
|ordered  
|numbered = Template:Meetup/signup/sign-numbered
|unordered
|#default = Template:Meetup/signup/sign-bullet
}}
editintro   = {{{editintro|Template:Meetup/signup/editintro}}}
nosummary   = true
hidden      = yes
page        = View it! Tool#Testing sign up
buttonlabel = {{{text|&emsp;&emsp;&emsp;Sign up&emsp;&emsp;&emsp;}}}
bgcolor     = {{{bgcolor|}}}
</inputbox></div><noinclude>

== Status ==
=== August 2022 ===
The team is investigating community wishes and best technical approaches. 
[[File:Wikimania 324.jpg|thumb|View it! tool presentation at Wikimania 2022/Pittsburgh Meetup]]
[[File:WREN Call with View it!.webm|thumb|thumbtime=0:32|Presentation recording from the August 31st meeting]]
* Wednesday, August 31, 2022 16:00 UTC: A virtual presentation and discussion was held during the [[Wikimedians in Residence Exchange Network]] monthly meeting, with anyone is welcome to attend. 
** [[View it! Tool/WREN notes|Notes from the meeting]]
* Saturday, August 13, 2022: In-person presentation/listening session, "Discoverability, Structured Data & the View it! tool" at Carnegie Library, East Liberty, Meeting Room 3. 130 S. Whitfield Street Pittsburgh, PA 15206 (second floor, handicap accessible).
** [[View it! Tool/Wikimania notes|Notes from the meeting]]

=== September 2022 ===
The development team is currently working to make the tool multilingual. Please help us with [[View_it!_Tool/localization_instructions|localization]]!

=== October 2022 ===
* View it! now has a Common's category search in the Advanced search function on Toolforge. 
* View it! is available across all Wikimedia namespaces, including Wikisource author and index pages. 
* View it! has been installed by 97 users; and has been translated into 14 languages.

=== November/December 2022 ===
* View it! had been re-envisioned into two versions - full and lite.
* The full version now includes an image carousel on each content page which can be expanded for pagniation.
* You can also look at a full-screen gallery by clicking the "View" tab.

== Usage ==
* As of August 2024, 170 users have installed View it! across global, Commons, and various language specific projects.
* View it! has also been modified and added to other projects and utilized in other search queries:
** It has been embedded in [https://iw.toolforge.org/itnsyn ITN Syndication]
** [[d:Template:Item documentation|Template:Item documentation]] on Wikidata
** View it! inspired the design on the Commons search in [https://conze.pt/ Conzept] and was modified to include a modal-image view and zoom option ([https://conze.pt/explore/Ant?l=en&d=wikipedia,wikidata&t=link&i=Q7386&u=%2Fapp%2Fcommons%2F%3Fq%3DQ7386%26l%3Den&s=true# example]).

== Timeline ==
The project was funded for development by the Wikimedia Foundation's [[mw:Structured Data Across Wikimedia|Structured Data Across Wikimedia]] project, and has a 6 month timeline. View it! will be completed by January 2023.

== Team ==

To share opinions, wishes, or ask questions please leave a message on the talk page. If you wish to reach a team member directly, please feel free to leave a message on our respective talk pages:
* Project Manager - [[User:Dominic|Dominic]]
* Lead Developer - [[User:SuperHamster|SuperHamster]]
* Community Outreach Manager - [[User:JamieF|JamieF]]

<!--Please do not write below this line or remove this line. Place comments above this line.-->
== Beta testers ==
[[View it! Tool/Beta testing archive|Testing announcement archive]]

Thank you to those who participated in Beta testing and provided valuable feedback for View it!:

{{:View it! Tool/Beta testing}}

== Update Sign up ==
{{:View it! Tool/Update sign up}}
[[Category:Tools and scripts]]