Patch #17924

Structured Document list for more flexible UI design with CSS

Added by Yonghwan SO about 7 years ago. Updated about 1 month ago.

Status:NewStart date:
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:Documents
Target version:5.0.0

Description

Current version of Document list is built with h4, p, and div for title, updated date and description on same depth with parent h3 in HTML structure.

h2. Document
h3. Technical documentation
h4. My First Document
p. updated time
div. description
h4. My Second Document
p. updated time
div. description

In this structure, page customizing is not easy and list scroll is heavy if there is so many documents. and someone like me want to see more structured view like:

h2. Document
` h3. Technical documentation
  | h4. My First Document
  | | p. updated time
  | ` div. description
  ` h4. My Second Document
    | p. updated time
    ` div. description

I Think, sometimes table view is more fit to document list and sometimes current Page-like view with indents is more fit for some project. so using div is more flexible for customizing the view per usage.

Attached patch includes view patch to add hirerachy for document elements and example css for alternate style is for table like inline view.

please consider this patch. I will make pull request on github too.

structured-document-list.patch Magnifier (1.05 KB) Yonghwan SO, 2014-09-22 05:15

0001-Structure-the-document-list.patch Magnifier (2.52 KB) Mizuki ISHIKAWA, 2021-08-17 02:33

0002-Structure-the-document-show-page.patch Magnifier (1.9 KB) Mizuki ISHIKAWA, 2021-08-17 02:33

0001-Structure-the-document-list.patch Magnifier (4.9 KB) Mizuki ISHIKAWA, 2021-08-17 03:30

0002-Structure-the-document-show-page.patch Magnifier (1.9 KB) Mizuki ISHIKAWA, 2021-08-17 03:30

History

#1 Updated by Yonghwan SO about 7 years ago

Oops! I read wiki Contribute now. I will not make pull request on github. sorry.

#2 Updated by Mizuki ISHIKAWA about 1 month ago

+1
I'm developing a Redmine theme. Document module pages are difficult to customize.

I will attach a patch with a slightly increased hierarchy in consideration of customizing with the theme. I also added a class for each element.

h2. Document
div#document-list
  div.document-group
    h3.group-name Technical documentation
    div.document-item
      h4.title My First Document
      div.updated-on updated time
      div.description Description
    div.document-item
      h4.title My Second Document
      div.updated-on updated time
      div.description Description2
  div.document-group
    div.document-item
      ...

I think the document list and how the document display page should be structured.
0002-Structure-the-document-show-page.patch changes the structure of the document display page as follows:

h2.title My First Document
div#document-details
  div.attributes
    div.category-name
    div.created-on
    ul.document-custom-field-values
      li
  div.description
  div.attachemnts-area

#4 Updated by Mischa The Evil about 1 month ago

@Mizuki: This seems a good improvement to me. Maybe you can add some screenshots to show the actual result?

#5 Updated by Mizuki ISHIKAWA about 1 month ago

Mischa The Evil wrote:

@Mizuki: This seems a good improvement to me. Maybe you can add some screenshots to show the actual result?

Thanks for your feedback.
This patch changes the HTML structure, not the design of the documentation pages.
I think that attaching a screenshot of the screen is not helpful for the review as it is the same view as before the change.

#6 Updated by Mischa The Evil about 1 month ago

Mizuki ISHIKAWA wrote:

Mischa The Evil wrote:

@Mizuki: This seems a good improvement to me. Maybe you can add some screenshots to show the actual result?

[...]
This patch changes the HTML structure, not the design of the documentation pages.
I think that attaching a screenshot of the screen is not helpful for the review as it is the same view as before the change.

My bad, you're right. I got distracted and finally mislead by the combination of the words increased hierarchy along with the indentation of the HTML structure examples given in the initial post and in your note. Nevermind me asking about this...

#7 Updated by Go MAEDA about 1 month ago

  • Category changed from UI to Documents
  • Target version set to Candidate for next major release

#8 Updated by Go MAEDA about 1 month ago

  • Target version changed from Candidate for next major release to 5.0.0

Setting the target version to 5.0.0.

Also available in: Atom PDF