Skip to content

Commit

Permalink
Merge pull request #571 from spencermountain/dev
Browse files Browse the repository at this point in the history
Dev
  • Loading branch information
spencermountain authored Dec 28, 2023
2 parents e49e3c2 + 32d6737 commit 1e875e0
Show file tree
Hide file tree
Showing 43 changed files with 4,562 additions and 630 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ run it on the client-side:
```html
<script src="https://unpkg.com/wtf_wikipedia"></script>
<script>
wtf.fetch('Radiohead', {'Api-User-Agent': 'Name your script here'}, function (err, doc) {
wtf.fetch('Radiohead', { 'Api-User-Agent': 'Name your script here' }, function (err, doc) {
let members = doc.infobox().get('current members')
members.links().map((l) => l.page())
//['Thom Yorke', 'Jonny Greenwood', 'Colin Greenwood'...]
Expand Down Expand Up @@ -276,7 +276,9 @@ wtf(txt)

```javascript
let txt = `Whistling is featured in a number of television shows, such as [[Lassie (1954 TV series)|''Lassie'']], and the title theme for ''[[The X-Files]]''.`
wtf(txt).links().map((l) => l.page())
wtf(txt)
.links()
.map((l) => l.page())
// [ 'Lassie (1954 TV series)', 'The X-Files' ]
```

Expand All @@ -285,7 +287,8 @@ wtf(txt).links().map((l) => l.page())
returns nice plain-text of the article

```js
let txt = "[[Greater_Boston|Boston]]'s [[Fenway_Park|baseball field]] has a {{convert|37|ft}} wall.<ref>{{cite web|blah}}</ref>"
let txt =
"[[Greater_Boston|Boston]]'s [[Fenway_Park|baseball field]] has a {{convert|37|ft}} wall.<ref>{{cite web|blah}}</ref>"
wtf(txt).text()
//"Boston's baseball field has a 37ft wall."
```
Expand Down Expand Up @@ -395,7 +398,6 @@ wtf.random().then((doc) => {

see [wtf-plugin-api](./plugins/api)


<!-- spacer -->
<img height="50px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>

Expand Down Expand Up @@ -459,7 +461,6 @@ await wtf.fetch('Ziggy Stardust', 'fr').infobox().json()
<img height="50px" src="https://user-images.githubusercontent.com/399657/68221824-09809d80-ffb8-11e9-9ef0-6ed3574b0ce8.png"/>
</div>


### Good practice:

The wikipedia api is [pretty welcoming](https://www.mediawiki.org/wiki/API:Etiquette#Request_limit) though recommends three things, if you're going to hit it heavily -
Expand Down Expand Up @@ -497,6 +498,7 @@ wtf
- **.isRedirect()** - if the page is just a redirect to another page
- **.redirectTo()** - the page this redirects to
- **.isDisambiguation()** - is this a placeholder page to direct you to one-of-many possible pages
- **.isStub()** - if the page is flagged as incomplete
- **.categories()** - return all categories of the document
- **.sections()** - return a list of the Document's sections
- **.paragraphs()** - return a list of Paragraphs, in all sections
Expand All @@ -512,6 +514,10 @@ wtf
- **.text()** - plaintext, human-readable output for the page
- **.json()** - a 'stringifyable' output of the page's main data
- **.wikitext()** - original wiki markup
- **.description()** - get/set the page's short description, if we have one.
- **.pageImage()** - get/set the page's representative image, if we have one.
- **.revisionID()** - get/set the latest edit id of the page, if we have it.
- **.timestamp()** - get/set the time of the most recent edit of the page, if we have it.

### Section

Expand Down Expand Up @@ -659,12 +665,12 @@ by default, if there's no parser for a template, it will be just ignored and gen
However, it's possible to configure a fallback parser function to handle these templates:

```js
wtf('some {{weird_template}} here', {
wtf('some {{weird_template}} here', {
templateFallbackFn: (tmpl, list, parse) => {
let obj = parse(tmpl) //or do a custom regex
list.push(obj)
return '[unsupported template]' // or return null to ignore this template
}
},
})
```

Expand Down
2 changes: 1 addition & 1 deletion builds/wtf_wikipedia-client.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion builds/wtf_wikipedia-client.mjs

Large diffs are not rendered by default.

Loading

0 comments on commit 1e875e0

Please sign in to comment.