Skip to content

More all config layout changes #4692

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Oct 23, 2019
Merged

More all config layout changes #4692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
bb4a3f3
Removed collapse/expand all
FroMage Oct 21, 2019
9139d76
Remove expand cell on three columns
FroMage Oct 21, 2019
e1cd7f8
Add column headers to every section
FroMage Oct 21, 2019
666c80c
Fixed expand/collapse toggle
FroMage Oct 21, 2019
9805ed6
Put expand/collapse link on the left with a title
FroMage Oct 21, 2019
6181b01
Removed expand/collapse link
FroMage Oct 21, 2019
be1475b
Added the column labels to the extension header row
FroMage Oct 21, 2019
7898051
New CSS from Andy
FroMage Oct 21, 2019
835e82d
AllConfigGenerator: don't use system.exit for Maven
FroMage Oct 21, 2019
091f59d
Make odd/event calculated in JS
FroMage Oct 21, 2019
460ed59
AllConfigGenerator: add json file as argument
FroMage Oct 22, 2019
01cc063
Make sure stand-alone config pages that don't have a section end up w…
FroMage Oct 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions .../src/main/java/io/quarkus/annotation/processor/generate_doc/SummaryTableDocFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
final class SummaryTableDocFormatter implements DocFormatter {
private static final String TABLE_CLOSING_TAG = "\n|===";
private static final String TABLE_ROW_FORMAT = "\n\na|%s `%s`\n\n[.description]\n--\n%s\n--|%s %s\n|%s\n";
private static final String TABLE_SECTION_ROW_FORMAT = "\n\n3+h|%s";
private static final String TABLE_HEADER_FORMAT = "[.configuration-legend]%s\n[.configuration-reference, cols=\"80,.^10,.^10\"]\n|===\n|Configuration property|Type|Default";
private static final String TABLE_SECTION_ROW_FORMAT = "\n\nh|%s\nh|Type\nh|Default";
private static final String TABLE_HEADER_FORMAT = "[.configuration-legend]%s\n[.configuration-reference, cols=\"80,.^10,.^10\"]\n|===";
// private static final String MORE_INFO_ABOUT_SECTION_FORMAT = "link:#%s[icon:plus-circle[], title=More information about %s]";

/**
Expand All @@ -24,6 +24,11 @@ public void format(Writer writer, List<ConfigDocItem> configDocItems) throws IOE
final String tableHeaders = String.format(TABLE_HEADER_FORMAT, Constants.CONFIG_PHASE_LEGEND);
writer.append(tableHeaders);

// make sure that section-less configs get a legend
if (configDocItems.isEmpty() || configDocItems.get(0).isConfigKey()) {
writer.append(String.format(TABLE_SECTION_ROW_FORMAT, "Configuration property"));
}

for (ConfigDocItem configDocItem : configDocItems) {
configDocItem.accept(writer, this);
}
Expand Down
1 change: 1 addition & 0 deletions docs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
<mainClass>io.quarkus.docs.generation.AllConfigGenerator</mainClass>
<arguments>
<argument>${project.version}</argument>
<argument>${project.basedir}/../devtools/bom-descriptor-json/target/extensions.json</argument>
</arguments>
<environmentVariables>
<MAVEN_CMD_LINE_ARGS>${env.MAVEN_CMD_LINE_ARGS}</MAVEN_CMD_LINE_ARGS>
Expand Down
201 changes: 51 additions & 150 deletions docs/src/main/asciidoc/javascript/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@ if(tables){
makeCollapsible(input, description);
}
}
var rowIdx = 0;
for (var row of table.querySelectorAll("tr")) {
var heads = row.querySelectorAll("th");
if(!heads || heads.length == 0){
// mark even rows
if(++rowIdx % 2){
row.classList.add("odd");
}else{
row.classList.remove("odd");
}
}else{
// reset count at each section
rowIdx = 0;
}
}
}
}

Expand Down Expand Up @@ -95,7 +110,6 @@ function clearHighlights(table){
}

function findText(row, search){
// return row.text().toLowerCase().indexOf(search) != -1;
var iter = document.createNodeIterator(row, NodeFilter.SHOW_TEXT, null);

while (n = iter.nextNode()){
Expand Down Expand Up @@ -137,23 +151,11 @@ function reinstallClickHandlers(input, table){
var td = getAncestor(descDiv, "td");
var row = td.parentNode;
var decoration = content.lastElementChild;
var iconDecoration1 = decoration.children.item(0);
var iconDecoration2 = decoration.children.item(1);
var iconDecoration3 = decoration.children.item(2);
var collapsibleLink = content.children.item(1);
var collapsibleAllLink = content.children.item(0);
var iconExpand = collapsibleLink.children.item(0);
var iconCollapse = collapsibleLink.children.item(1);
var iconExpandAll = collapsibleAllLink.children.item(0);
var iconCollapseAll = collapsibleAllLink.children.item(1);
var iconDecoration = decoration.children.item(0);
var collapsibleSpan = decoration.children.item(1);
var collapsibleHandler = makeCollapsibleHandler(input, descDiv, td, row,
collapsibleLink, collapsibleAllLink,
iconCollapse, iconCollapseAll, iconExpand, iconExpandAll,
iconDecoration1, iconDecoration2, iconDecoration3);
var collapsibleAllHandler = makeCollapsibleAllHandler(input, descDiv);

collapsibleLink.addEventListener('click', collapsibleHandler);
collapsibleAllLink.addEventListener('click', collapsibleAllHandler);
collapsibleSpan,
iconDecoration);

row.addEventListener("click", collapsibleHandler);
}
Expand Down Expand Up @@ -187,7 +189,20 @@ function applySearch(table, search, autoExpand){
// clear highlights
clearHighlights(table);
var lastSectionHeader = null;
var idx = 0;
for (var row of table.querySelectorAll("tr")) {
var heads = row.querySelectorAll("th");
if(!heads || heads.length == 0){
// mark even rows
if(++idx % 2){
row.classList.add("odd");
}else{
row.classList.remove("odd");
}
}else{
// reset count at each section
idx = 0;
}
if(!search){
row.style.removeProperty("display");
// recollapse when searching is over
Expand All @@ -196,17 +211,10 @@ function applySearch(table, search, autoExpand){
&& !row.classList.contains("row-collapsed"))
row.click();
}else{
var heads = row.querySelectorAll("th");
if(heads && heads.length > 0){
if(heads.length > 1){
// always show the top header, never highlight it
row.style.removeProperty("display");
}else{
// keep the header rows for rows who matched, but start hidden
lastSectionHeader = row;
highlight(row, search);
row.style.display = "none";
}
// keep the column header with no highlight, but start hidden
lastSectionHeader = row;
row.style.display = "none";
}else if(findText(row, search)){
row.style.removeProperty("display");
// expand if shown
Expand Down Expand Up @@ -249,53 +257,22 @@ function makeCollapsible(input, descDiv){
}

if (descHeightLong - descHeightShort > 16) {
var iconDecoration1 = document.createElement("i");
iconDecoration1.classList.add('fa', 'fa-chevron-down');
var iconDecoration2 = iconDecoration1.cloneNode();
var iconDecoration3 = iconDecoration1.cloneNode();
var iconDecoration = document.createElement("i");
iconDecoration.classList.add('fa', 'fa-chevron-down');

var descDecoration = document.createElement("div");
descDecoration.classList.add('description-decoration');
descDecoration.appendChild(iconDecoration1);
descDecoration.appendChild(iconDecoration2);
descDecoration.appendChild(iconDecoration3);
descDecoration.appendChild(iconDecoration);

var iconExpand = document.createElement("i");
iconExpand.classList.add('fa', 'fa-chevron-down');
var iconExpandAll = document.createElement("i");
iconExpandAll.classList.add('fa', 'fa-chevron-circle-down');
var iconCollapse = document.createElement("i");
iconCollapse.classList.add('fa', 'fa-chevron-up');
iconCollapse.style.display = "none";
var iconCollapseAll = document.createElement("i");
iconCollapseAll.classList.add('fa', 'fa-chevron-circle-up');
iconCollapseAll.style.display = "none";
var collapsibleSpan = document.createElement("span");
collapsibleSpan.appendChild(document.createTextNode("Show more"));
descDecoration.appendChild(collapsibleSpan);

var collapsibleLink = document.createElement("a");
collapsibleLink.setAttribute("href", "#");
collapsibleLink.appendChild(iconExpand);
collapsibleLink.appendChild(iconCollapse);
collapsibleLink.appendChild(document.createTextNode("Expand"));
collapsibleLink.classList.add('link-collapsible');

var collapsibleAllLink = document.createElement("a");
collapsibleAllLink.setAttribute("href", "#");
collapsibleAllLink.appendChild(iconExpandAll);
collapsibleAllLink.appendChild(iconCollapseAll);
collapsibleAllLink.appendChild(document.createTextNode("(All)"));
collapsibleAllLink.classList.add('link-collapsible');

var collapsibleHandler = makeCollapsibleHandler(input, descDiv, td, row,
collapsibleLink, collapsibleAllLink,
iconCollapse, iconCollapseAll, iconExpand, iconExpandAll,
iconDecoration1, iconDecoration2, iconDecoration3);
var collapsibleAllHandler = makeCollapsibleAllHandler(input, descDiv);

collapsibleLink.addEventListener('click', collapsibleHandler);
collapsibleAllLink.addEventListener('click', collapsibleAllHandler);
collapsibleSpan,
iconDecoration);

var parent = descDiv.parentNode;
parent.insertBefore(collapsibleLink, parent.firstChild);
parent.insertBefore(collapsibleAllLink, parent.firstChild);

parent.appendChild(descDecoration);
row.classList.add("row-collapsible", "row-collapsed");
Expand All @@ -308,105 +285,29 @@ function makeCollapsible(input, descDiv){
};

function makeCollapsibleHandler(input, descDiv, td, row,
collapsibleLink, collapsibleAllLink,
iconCollapse, iconCollapseAll, iconExpand, iconExpandAll,
iconDecoration1, iconDecoration2, iconDecoration3) {
collapsibleSpan,
iconDecoration) {

return function(event) {
var target = event.target;
if( (target.localName == 'a' || getAncestor(target, "a"))
&& target != collapsibleLink ) {
if( (target.localName == 'a' || getAncestor(target, "a"))) {
return;
}

var isCollapsed = descDiv.classList.contains('description-collapsed');
if( isCollapsed ) {
iconCollapse.style.removeProperty("display");
iconExpand.style.display = "none";
collapsibleLink.childNodes.item(1).nodeValue = 'Collapse';
iconCollapseAll.style.removeProperty("display");
iconExpandAll.style.display = "none";
iconDecoration1.classList.replace('fa-chevron-down', 'fa-chevron-up');
iconDecoration2.classList.replace('fa-chevron-down', 'fa-chevron-up');
iconDecoration3.classList.replace('fa-chevron-down', 'fa-chevron-up');
td.setAttribute("colspan", 3);
var typeCell = td.nextElementSibling.firstElementChild;
if(typeCell){
var cell = typeCell.cloneNode(true);
cell.classList.add("remove-on-collapse");
var labelSpan = document.createElement("span");
labelSpan.appendChild(document.createTextNode("Type: "));
labelSpan.classList.add("description-label");
cell.insertBefore(labelSpan, cell.firstChild);
descDiv.appendChild(cell);
}
var defaultCell = td.nextElementSibling.nextElementSibling.firstElementChild;
if(defaultCell){
var cell = defaultCell.cloneNode(true);
cell.classList.add("remove-on-collapse");
var labelSpan = document.createElement("span");
labelSpan.appendChild(document.createTextNode("Defaults to: "));
labelSpan.classList.add("description-label");
cell.insertBefore(labelSpan, cell.firstChild);
descDiv.appendChild(cell);
}
collapsibleSpan.childNodes.item(0).nodeValue = 'Show less';
iconDecoration.classList.replace('fa-chevron-down', 'fa-chevron-up');
}
else {
iconExpand.style.removeProperty("display");
iconCollapse.style.display = "none";
collapsibleLink.childNodes.item(1).nodeValue = 'Expand';
iconExpandAll.style.removeProperty("display");
iconCollapseAll.style.display = "none";
iconDecoration1.classList.replace('fa-chevron-up', 'fa-chevron-down');
iconDecoration2.classList.replace('fa-chevron-up', 'fa-chevron-down');
iconDecoration3.classList.replace('fa-chevron-up', 'fa-chevron-down');
td.removeAttribute("colspan");
var toRemoveList = descDiv.querySelectorAll(".remove-on-collapse");
if(toRemoveList){
for(var toRemove of toRemoveList){
toRemove.parentNode.removeChild(toRemove);
}
}
collapsibleSpan.childNodes.item(0).nodeValue = 'Show more';
iconDecoration.classList.replace('fa-chevron-up', 'fa-chevron-down');
}
descDiv.classList.toggle('description-collapsed');
descDiv.classList.toggle('description-expanded');
row.classList.toggle('row-collapsed');
td.nextElementSibling.classList.toggle("hidden");
td.nextElementSibling.nextElementSibling.classList.toggle("hidden");

if( target.localName == 'a' && target.classList.contains('link-collapsible') ) {
event.preventDefault();
event.stopPropagation();
}
};
}


function makeCollapsibleAllHandler(input, descDiv) {
return function(event){
var target = event.target;

var isCollapsed = descDiv.classList.contains('description-collapsed');

var table = getShadowTable(input);
collapseAll(table, isCollapsed);
applySearch(table, inputs[input.id].lastSearch, false);
swapShadowTable(input);

event.preventDefault();
event.stopPropagation();
};
}

function collapseAll(table, isCollapsed){
var target = isCollapsed ? ".description-collapsed" : ".description-expanded";
var toClickList = table.querySelectorAll(target);
if(toClickList){
for(var toClick of toClickList){
var tr = getAncestor(toClick, "tr");
tr.click();
}
}
}

});
Loading