Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PageImages support for mode=gallery on non file pages #275

Merged
merged 34 commits into from
May 24, 2024

Conversation

domino-1
Copy link
Contributor

In gallery mode, attempting to automatically detect whether:

  • PageImages is enabled
  • If it is, if a non file page has a PageImage
    If both are true, it should try to use the PageImage for the gallery and the page name for the image caption.

Right now, it also makes the page name in the caption a link, and points the image link to the page as well. Could not figure out how to make this behavior optional.

Gallery mode for file pages should be untouched.

Notes:

  • This behavior is similar, but not a perfect match to DPL_(Wikimedia)'s PageImages in gallery mode.
  • Unsure if some of the solutions are the most optimal. The way its detecting if PageImages is enabled is a bit clumsy.

Copy link

coderabbitai bot commented May 23, 2024

Important

Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@domino-1
Copy link
Contributor Author

Extra context: This was originally written around 2022 for a wiki in MW1.35. During a recent update cleaned up the code a bit and tested it on a blank install of MW1.41.

$img = $repoGroup->findFile( Title::makeTitle( NS_FILE, $pageImage ) );
if ( $img && $img->exists() ) {
$imageUrl = $img->getURL();
} else {

Check warning

Code scanning / Phpmd (reported by Codacy)

Use return statements instead of else expression Warning

The method parseImageUrlWithPath uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
includes/Lister/Lister.php Dismissed Show dismissed Hide dismissed
includes/Lister/GalleryList.php Fixed Show fixed Hide fixed
includes/Lister/GalleryList.php Fixed Show fixed Hide fixed
Copy link
Owner

@Universal-Omega Universal-Omega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks mostly good, just some formatting things. I apologize if I am being over picky about it.

includes/Lister/GalleryList.php Outdated Show resolved Hide resolved
includes/Lister/GalleryList.php Outdated Show resolved Hide resolved
includes/Lister/GalleryList.php Outdated Show resolved Hide resolved
includes/Lister/GalleryList.php Outdated Show resolved Hide resolved
includes/Lister/Lister.php Outdated Show resolved Hide resolved
includes/Lister/GalleryList.php Show resolved Hide resolved
includes/Lister/GalleryList.php Outdated Show resolved Hide resolved
includes/Lister/Lister.php Outdated Show resolved Hide resolved
includes/Lister/Lister.php Outdated Show resolved Hide resolved
includes/Lister/Lister.php Outdated Show resolved Hide resolved
domino-1 and others added 18 commits May 24, 2024 00:01
@domino-1
Copy link
Contributor Author

domino-1 commented May 23, 2024

Thank you for all the fixes and formatting!

Copy link
Contributor Author

@domino-1 domino-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went through them, I think I got them all. Should I try removing the else branches that the GH bot is complaining about or are those fine to stay?

@domino-1 domino-1 requested a review from Universal-Omega May 23, 2024 22:42
$img = $repoGroup->findFile( Title::makeTitle( NS_FILE, $pageImage ) );
if ( $img && $img->exists() ) {
$imageUrl = $img->getURL();
} else {

Check warning

Code scanning / Phpmd (reported by Codacy)

Use return statements instead of else expression Warning

The method formatItem uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
// Failed to get a page image
$item = $this->getItemStart() . $item . $this->itemEnd . '[[' . $item . ']]';
}
} else {

Check warning

Code scanning / Phpmd (reported by Codacy)

Use return statements instead of else expression Warning

The method formatItem uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
if ( $pageImage ) {
// Successfully got a page image, wrapping it
$item = $this->getItemStart() . $pageImage . '| [[' . $item . ']]' . $this->itemEnd . 'link=' . $item;
} else {

Check warning

Code scanning / Phpmd (reported by Codacy)

Use return statements instead of else expression Warning

The method formatItem uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
@Universal-Omega Universal-Omega merged commit df4ff96 into Universal-Omega:master May 24, 2024
10 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants