Skip to content

Commit 6211085

Browse files
authored
Update README.md (#89)
* Update README.md * typos and tweaks * Update README.md - work on nitpicks
1 parent 10aa846 commit 6211085

File tree

1 file changed

+40
-39
lines changed

1 file changed

+40
-39
lines changed

README.md

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
The **Network** extension allows visualizing connections between wiki pages via an interactive network graph.
99

10-
It was created by [Professional Wiki](https://professional.wiki/) and funded by
10+
It was created by [Professional Wiki] and funded by
1111
[KDZ - Centre for Public Administration Research](https://www.kdz.eu/).
1212

1313
<a href="https://raw.githubusercontent.com/ProfessionalWiki/Network/master/.github/network.png"><img src=".github/network.png" width="350px" title="View image" /></a>
@@ -30,8 +30,8 @@ It was created by [Professional Wiki](https://professional.wiki/) and funded by
3030

3131
## Platform requirements
3232

33-
* PHP 7.4 or later (tested up to PHP 8.4)
34-
* MediaWiki 1.39.x or later (tested up to 1.43.x)
33+
- PHP 7.4 or later (tested up to PHP 8.4)
34+
- MediaWiki 1.39.x or later (tested up to 1.43.x)
3535

3636
See the [release notes](#release-notes) for more information on the different versions of Network.
3737

@@ -43,17 +43,17 @@ The recommended way to install Network is using [Composer](https://getcomposer.o
4343
On the commandline, go to your wikis root directory. Then run these two commands:
4444

4545
```shell script
46-
COMPOSER=composer.local.json composer require --no-update professional-wiki/network:~2.0
46+
COMPOSER=composer.local.json composer require --no-update professional-wiki/network:~3.0
4747
composer update professional-wiki/network --no-dev -o
4848
```
4949

50-
Then enable the extension by adding the following to the bottom of your wikis `LocalSettings.php` file:
50+
Then enable the extension by adding the following to the bottom of your wiki's `LocalSettings.php` file:
5151

5252
```php
5353
wfLoadExtension( 'Network' );
5454
```
5555

56-
You can verify the extension was enabled successfully by opening your wikis Special:Version page in your browser.
56+
You can verify the extension was enabled successfully by opening your wiki's Special:Version page in your browser.
5757

5858
Finally, please consider [sponsoring the project].
5959

@@ -234,16 +234,16 @@ Where `NetworkPages` contains `Page1 | Page2 | Page3` and `NetworkOptions` conta
234234

235235
## PHP Configuration
236236

237-
The default value of all parameters can be changed by placing configuration in "LocalSettings.php".
237+
The default value of all parameters can be changed by placing the configuration in "LocalSettings.php".
238238
These configuration settings are available:
239239

240-
* `$wgPageNetworkOptions` – options passed directly to the graph visualization library
241-
* `$wgPageNetworkExcludeTalkPages` - indicates if talk pages should be excluded
242-
* `$wgPageNetworkExcludedNamespaces` - IDs of namespaces to exclude
243-
* `$wgPageNetworkEnableDisplayTitle` - indicates if display title should be used for node labels by default
244-
* `$wgPageNetworkLabelMaxLength` - default maximum length for node labels
240+
- `$wgPageNetworkOptions` – options passed directly to the graph visualization library
241+
- `$wgPageNetworkExcludeTalkPages` - indicates if talk pages should be excluded
242+
- `$wgPageNetworkExcludedNamespaces` - IDs of namespaces to exclude
243+
- `$wgPageNetworkEnableDisplayTitle` - indicates if display title should be used for node labels by default
244+
- `$wgPageNetworkLabelMaxLength` - default maximum length for node labels
245245

246-
Default values of these configuration settings can be found in "extension.json". Do not change "extension.json".
246+
The default values of these configuration settings can be found in "extension.json". Do not change "extension.json".
247247

248248
**$wgPageNetworkOptions**
249249

@@ -316,7 +316,7 @@ internal links. To make them show up as internal links on the network graph, you
316316
setting is changed, you will need to run the `refreshLinks.php` MediaWiki maintenance script for the change to
317317
be recognized.
318318

319-
## Performance / caching
319+
## Performance/caching
320320

321321
This extension bypasses the MediaWiki page cache. This means that your network graphs will always be up to date,
322322
without needing to purge the page cache.
@@ -327,29 +327,29 @@ without needing to purge the page cache.
327327

328328
Pull requests to remove those limitations are welcome.
329329

330-
You can also contact [Professional.Wiki](https://professional.wiki/)
330+
You can also contact [Professional Wiki]
331331
for [Professional MediaWiki development](https://professional.wiki/en/mediawiki-development) services.
332332

333333
## Contribution and support
334334

335-
If you want to contribute work to the project please subscribe to the developers mailing list and
335+
If you want to contribute work to the project, please subscribe to the developers' mailing list and
336336
have a look at the contribution guideline.
337337

338338
* [File an issue](https://github.com/ProfessionalWiki/Network/issues)
339339
* [Submit a pull request](https://github.com/ProfessionalWiki/Network/pulls)
340340
* Ask a question on [the mailing list](https://www.semantic-mediawiki.org/wiki/Mailing_list)
341341

342342
[Professional MediaWiki support](https://professional.wiki/en/support) is available via
343-
[Professional.Wiki](https://professional.wiki/).
343+
[Professional Wiki]
344344

345345
## Development
346346

347347
Tests, style checks and static analysis can be run via Make. You can execute these commands on the command line
348348
in the `extensions/Network` directory:
349349

350-
* `make ci` - run everything
351-
* `make cs` - run style checks
352-
* `make test` - run the tests
350+
- `make ci` - run everything
351+
- `make cs` - run style checks
352+
- `make test` - run the tests
353353

354354
For more details see the `Makefile`.
355355

@@ -361,72 +361,73 @@ The JavaScript tests can only be run by going to the [`Special:JavaScriptTest` p
361361

362362
## Professional Support and Development
363363

364-
[Professional.Wiki] provides commercial [MediaWiki development], [managed wiki hosting] and [MediaWiki support].
364+
[Professional Wiki] provides commercial [MediaWiki development], [managed wiki hosting] and [MediaWiki support].
365365

366366
## Release notes
367367

368368
### Version 3.0.0
369369

370-
Release date July 7th, 2025.
370+
Released on July 7th, 2025.
371371

372-
* Raised minimum MediaWiki version from 1.31 to 1.39
372+
- Raised minimum MediaWiki version from 1.31 to 1.39
373+
- Translation updates for system messages (thanks @translatewiki and its translator community)
373374

374375
### Version 2.0.1
375376

376377
Released on December 9th, 2023.
377378

378-
* Fixed handling of redirects (thanks @thomas-topway-it)
379+
- Fixed handling of redirects (thanks @thomas-topway-it)
379380

380381
### Version 2.0.0
381382

382383
Released on July 11th, 2021.
383384

384-
* Added optional support for using display title for nodes' labels. (thanks @cicalese)
385-
* Added configurable maximum length for node labels. (thanks @cicalese)
386-
* Added tooltips to nodes. (thanks @cicalese)
387-
* Made styling of nodes representing links to existing pages and links to
385+
- Added optional support for using display title for nodes' labels. (thanks @cicalese)
386+
- Added configurable maximum length for node labels. (thanks @cicalese)
387+
- Added tooltips to nodes. (thanks @cicalese)
388+
- Made styling of nodes representing links to existing pages and links to
388389
missing pages configurable by adding vis.js groups named "bluelink" and
389390
"redlink". (thanks @cicalese)
390-
* Added support for OOUI icons. (thanks @cicalese)
391-
* Added support for external links. (thanks @cicalese)
391+
- Added support for OOUI icons. (thanks @cicalese)
392+
- Added support for external links. (thanks @cicalese)
392393

393394
### Version 1.4.0
394395

395396
Released on January 9, 2021.
396397

397-
* Upgraded viz-network from 8.3.2 to 8.5.5
398+
- Upgraded viz-network from 8.3.2 to 8.5.5
398399

399400
### Version 1.3.0
400401

401402
Released on September 8, 2020.
402403

403-
* Added WAI compliance by adding an aria-label attribute to the network canvas
404+
- Added WAI compliance by adding an aria-label attribute to the network canvas
404405

405406
### Version 1.2.1
406407

407408
Released on September 7, 2020.
408409

409-
* Added compatibility with MediaWiki 1.31
410+
- Added compatibility with MediaWiki 1.31
410411

411412
### Version 1.2.0
412413

413414
Released on September 7, 2020.
414415

415-
* Upgraded viz-network from 7.6 to 8.3
416+
- Upgraded viz-network from 7.6 to 8.3
416417

417418
### Version 1.1.1
418419

419420
Released on September 7, 2020.
420421

421-
* Made code more robust against invalid titles
422+
- Made code more robust against invalid titles
422423

423424
### Version 1.1.0
424425

425426
Released on August 30, 2020.
426427

427-
* Added `$wgPageNetworkExcludeTalkPages` option
428-
* Added `$wgPageNetworkExcludedNamespaces` option
429-
* Improved node repulsion physics
428+
- Added `$wgPageNetworkExcludeTalkPages` option
429+
- Added `$wgPageNetworkExcludedNamespaces` option
430+
- Improved node repulsion physics
430431

431432
### Version 1.0.0
432433

@@ -437,7 +438,7 @@ Initial release
437438
[MediaWiki:Common.css]: https://www.mediawiki.org/wiki/Manual:Interface/Stylesheets
438439
[JS tests]: https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing
439440
[sponsoring the project]: https://github.com/sponsors/JeroenDeDauw
440-
[Professional.Wiki]: https://professional.wiki
441+
[Professional Wiki]: https://professional.wiki
441442
[MediaWiki development]: https://professional.wiki/en/mediawiki-development
442443
[managed wiki hosting]: https://professional.wiki/en/hosting
443444
[MediaWiki support]: https://professional.wiki/en/support

0 commit comments

Comments
 (0)