Updated README with additional instructions for loading ZIM files and articles #60
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MohitMaliFtechiz
force-pushed
the
Issue#50
branch
from
74efbf0
to
296183d
Compare
Closed
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #60 +/- ##
=========================================
Coverage 92.38% 92.38%
Complexity 213 213
=========================================
Files 44 44
Lines 289 289
Branches 3 3
=========================================
Hits 267 267
Misses 19 19
Partials 3 3 ☔ View full report in Codecov by Sentry. |
mgautierfr
reviewed
Aug 2, 2023
MohitMaliFtechiz
force-pushed
the
Issue#50
branch
from
45d525c
to
91915d4
Compare
MohitMaliFtechiz
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Aug 2, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
mgautierfr
requested changes
Aug 2, 2023
MohitMaliFtechiz
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Aug 7, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
MohitMaliFtechiz
force-pushed
the
Issue#50
branch
from
91915d4
to
cb3dce7
Compare
…articles. This commit updates the README file to include additional instructions for loading ZIM files and accessing articles in the Kiwix content archive using the `java-libkiwix` library. Changes made in the README: - Added a section explaining how to load a ZIM file by creating an `Archive` object. - Clarified the description of the `mainPage` property, detailing its behavior when dealing with redirects and non-existent entries. - Provided code snippets and instructions for loading articles via title and path, including a reminder to properly decode the URL path before passing it to `hasEntryByPath`. These changes aim to improve the documentation and assist developers in effectively utilizing the `java-kibkiwix` library to work with zim files.
MohitMaliFtechiz
force-pushed
the
Issue#50
branch
from
cb3dce7
to
190473f
Compare
mgautierfr
approved these changes
Aug 11, 2023
MohitMaliFtechiz
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Aug 17, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
kelson42
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Aug 27, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
kelson42
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Aug 28, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
kelson42
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Aug 29, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
kelson42
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Aug 31, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
MohitMaliFtechiz
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Sep 5, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
kelson42
pushed a commit
to kiwix/kiwix-android
that referenced
this pull request
Sep 18, 2023
* We are previously checking `hasEntryByPath`, `hasEntryByTitle`, `mainEntry.isRedirect` which are internally calling the same function as we are calling after checking this condition so it would be better to directly use those function to avoid calling same function twice see more details kiwix/java-libkiwix#60.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #50
Changes made in the README:
Archiveobject.mainPageproperty, detailing its behavior when dealing with redirects and non-existent entries.hasEntryByPath.These changes aim to improve the documentation and assist developers in effectively utilizing the
java-kibkiwixlibrary to work with zim files.