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

Wiki page content title and overview numbering #357

Open
wants to merge 45 commits into
base: master
Choose a base branch
from

Conversation

vidhyasagargm
Copy link

Currently the wiki page doesnt have numbering for the content of the page or even at the overview. It makes it difficult to read the list of pages and also the content of the page. For better visibility and structure numbering for the overview of wiki pages and also the content of wiki page has been created. There is also a toggle button to enable and disable the numbering and a configuration at the config page of the module to set default settings of the numbering. An internal code review process has already been done upfornt for all the changes in this PR.

Here is some of the screenshots of showing numbering enabled and disabled:
Wiki content numbering enabled:
Screenshot (27)

Wiki content numbering disabled:
Screenshot (28)

Overview numbering enabled:
Screenshot (25)

Overview numbering disabled:
Screenshot (26)

vidhyasagargm and others added 30 commits September 12, 2024 15:30
…github.com/Neo-Atlas/humhub_wiki into 1-content-overview-title-numbering"

This reverts commit b1e21c5, reversing
changes made to 59ee21d.
removed addditional empty spaces
removed additional space and tabspace
Co-authored-by: Marius Meißner <[email protected]>
@mbumpalumpa
Copy link
Contributor

@vidhyasagargm, thank you for your PR. We’ve reviewed it, and it’s a great starting point. However, we would like you, if possible, to implement some changes/fixes.

1. Removing ON/OFF Button (Enh)
As this action can be defined within the module config, it is redundant to also have the button on the wiki itself. Additionally, there isn’t any viable reason why each user should be able to disable/enable the feature.

2. Space Module Config (Fix)
The setting for enabling/disabling the numeration feature should be on a per-space basis. This means that if Space A has it enabled and Space B has it disabled, they should not interfere with each other. Currently, if Space B changes to disable, the feature is disabled across all spaces.

Usually, global settings (Admin > Modules > Module Name), when set, are inherited by space-level module settings, allowing each space to customize the default setting to their needs.

3. Drag-and-Drop Feature Request Refresh (Fix)
The drag-and-drop feature for page reordering works, but the page needs to be refreshed for the numeration to update. This should be live-updated instead.

drag-and-drop.mov

4. Headings Numeration (Fix)
From your screenshots, I expected that H1, H2, H3, etc., would be auto-numerated (e.g., # Title rendered as 1. Title) without the user needing to manually write # 1. Title.

5. Suffix Numbers with Brackets (Enh)
Numeration should be suffixed with ")" (e.g., 1.), 1.1.), etc.).

6. Page Title Numeration
Page titles should also have numeration added automatically.

page-nume

We appreciate your effort and look forward to seeing the updated version. Let us know if you have any questions or need clarification. Thanks again for your contribution!

@vidhyasagargm
Copy link
Author

3. Drag-and-Drop Feature Request Refresh (Fix) The drag-and-drop feature for page reordering works, but the page needs to be refreshed for the numeration to update. This should be live-updated instead.

drag-and-drop.mov
4. Headings Numeration (Fix) From your screenshots, I expected that H1, H2, H3, etc., would be auto-numerated (e.g., # Title rendered as 1. Title) without the user needing to manually write # 1. Title.

Greetings @mbumpalumpa,
Thanks a lot for the review.

  • As for these Fix, it has already been done in this PR. As the changes are on CSS and JS file, I have not added the grunt built files. So you might have to do a grunt build so that the CSS and JS changes are updated.
  • For the other Fix and Enh, i will try to update you soon.

@mbumpalumpa
Copy link
Contributor

@vidhyasagargm Okay, great, thanks! Also, we reviewed the mockups of point 5: "5. Suffix Numbers with Brackets (Enh) Numeration should be suffixed with ')' (e.g., 1.), 1.1.), etc.)," and we decided that it doesn’t look very good, so please ignore it, thanks!

@vidhyasagargm
Copy link
Author

Hello @mbumpalumpa,
All have the issues have been fixed. Please do grunt build before testing. Eagerly waiting for your review. As for the point 6. Ehancement im still working on it will update you soon.

@vidhyasagargm
Copy link
Author

Hello @mbumpalumpa,
All of the fix and Ehn have been completed. Let me know if any modification or changes are required.

@mbumpalumpa
Copy link
Contributor

Hi @vidhyasagargm thanks! I will let you know when I'm done testing it.

@mbumpalumpa
Copy link
Contributor

Hi @vidhyasagargm I have checked everything, and it seems to work fine. However, there is one small issue. You can see in the screenshot below that numeration is turned off for this particular Space. Despite this, the title within the page is still prefixed with "1". So in cases where Numeration is disabled; titles shouldn't be auto-prefixed.

Numeration Off


Edit

Screenshot 2024-12-11 at 11-33-43 SP1 - PRIVATE - HumHub Test


View

Screenshot 2024-12-11 at 11-33-52 Headings - Wiki - SP1 - PRIVATE - HumHub Test


Numeration On

Screenshot 2024-12-11 at 11-34-18 Headings - Wiki - SP1 - PRIVATE - HumHub Test

@vidhyasagargm
Copy link
Author

Hello @mbumpalumpa,
It is fixed now. With enabling wiki page numbering the title numbering and path numbering appears and with disabling it disappears.

@mbumpalumpa
Copy link
Contributor

Hi @vidhyasagargm, thanks for the update! Everything is working fine now. One of our developers will be assigned to conduct a code review, after which we’ll inform you of the next steps. Thanks again!

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