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.

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

Jump to bottom

Fix figure caption position #565

Merged
merged 3 commits into from
Oct 20, 2023
Merged

Fix figure caption position #565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba455f5
Fix image positioning
vgeorge Oct 19, 2023
aa09225
Remove tables/image numbering from caption element as it is handled b…
vgeorge Oct 19, 2023
116a543
Improve comments, refactor numbering context
vgeorge Oct 19, 2023
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
35 changes: 0 additions & 35 deletions app/assets/scripts/components/slate/plugins/caption/caption.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ import { Node } from 'slate';
import { useReadOnly, useSelected } from 'slate-react';
import styled from 'styled-components';

import { NumberingContext } from '../../../../context/numbering';
import { IMAGE_BLOCK, TABLE_BLOCK } from '../constants';

const CaptionElement = styled.figcaption`
font-size: 0.875rem;
line-height: 1.25rem;
Expand All @@ -27,42 +24,11 @@ export function Caption(props) {
const { attributes, htmlAttributes, element, children } = props;
const isSelected = useSelected();
const readOnly = useReadOnly();
const id = JSON.stringify(element);
const { parent } = element;

const emptyCaption = !Node.string(element);
const numberingContext = React.useContext(NumberingContext);

const showPlaceholder = !readOnly && !isSelected && emptyCaption;

React.useEffect(() => {
if (numberingContext && !showPlaceholder && id) {
if (parent === TABLE_BLOCK) {
numberingContext.registerTable(id);
} else if (parent === IMAGE_BLOCK) {
numberingContext.registerImage(id);
}
}
}, [numberingContext, showPlaceholder, id, parent]);

const numbering = React.useMemo(() => {
if (!numberingContext) {
return null;
}

if (parent === TABLE_BLOCK) {
return numberingContext.getTableNumbering(id);
}

if (parent === IMAGE_BLOCK) {
return numberingContext.getImageNumbering(id);
}

return null;
}, [numberingContext, parent, id]);

// if (readOnly && emptyCaption) return null;

// The current version of Slate has no way to render a placeholder on an
// element. The best way is to create an element which is absolutely
// positioned and has no interaction.
Expand All @@ -71,7 +37,6 @@ export function Caption(props) {
{showPlaceholder && (
<Placeholder contentEditable={false}>Write a caption</Placeholder>
)}
{numbering}
{children}
</CaptionElement>
);
Expand Down
72 changes: 5 additions & 67 deletions app/assets/scripts/context/numbering.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { createContext, useCallback, useMemo, useState } from 'react';

/**
* Provides a context for equation numbering.
*/
export function useNumberingProviderValue() {
const [registeredEquations, setRegisteredEquations] = useState({});
const [registeredImages, setRegisteredImages] = useState({});
const [registeredTables, setRegisteredTables] = useState({});

const registerEquation = useCallback((key) => {
setRegisteredEquations((prevElements) => {
Expand All @@ -19,34 +20,6 @@ export function useNumberingProviderValue() {
});
}, []);

const registerImage = useCallback((key) => {
setRegisteredImages((prevElements) => {
if (prevElements[key]) {
return prevElements;
}

const numElements = Object.keys(prevElements).length;
return {
...prevElements,
[key]: numElements + 1
};
});
}, []);

const registerTable = useCallback((key) => {
setRegisteredTables((prevElements) => {
if (prevElements[key]) {
return prevElements;
}

const numElements = Object.keys(prevElements).length;
return {
...prevElements,
[key]: numElements + 1
};
});
}, []);

const getEquationNumbering = useCallback(
(key) => {
const numbering = registeredEquations[key];
Expand All @@ -59,47 +32,12 @@ export function useNumberingProviderValue() {
[registeredEquations]
);

const getTableNumbering = useCallback(
(key) => {
const numbering = registeredTables[key];
if (!numbering) {
return '';
}

return `Table ${numbering}: `;
},
[registeredTables]
);

const getImageNumbering = useCallback(
(key) => {
const numbering = registeredImages[key];
if (!numbering) {
return '';
}

return `Figure ${numbering}: `;
},
[registeredImages]
);

return useMemo(
() => ({
getEquationNumbering,
getTableNumbering,
getImageNumbering,
registerEquation,
registerTable,
registerImage
registerEquation
}),
[
getEquationNumbering,
getTableNumbering,
getImageNumbering,
registerEquation,
registerTable,
registerImage
]
[getEquationNumbering, registerEquation]
);
}

Expand Down
49 changes: 29 additions & 20 deletions app/assets/scripts/utils/apply-number-captions-to-document.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ import {
} from '../components/slate/plugins/constants';

/**
* Include table numbers and move captions before the table in the document.
* Include tables and figures numbers to their captions. We don't use a
* numbering context (like equation numbering) because we also need to change
* the position of the caption in the document, which is not possible with the
* current implementation of equation numbering context.
*/
export function applyNumberCaptionsToDocument(document) {
// Section id list in the order they should appear in the document
Expand Down Expand Up @@ -71,27 +74,33 @@ export function applyNumberCaptionsToDocument(document) {
child.type === TABLE_BLOCK ? 'Table' : 'Figure'
} ${elementCount[child.type]}: `;

// Reverse the table rows to make caption appear first
// and add the table number to the caption
return {
...child,
children: child.children.reverse().map((c) => {
if (c.type !== 'caption') {
return c;
}
// Prefix the caption with the table/image number
const children = child.children.map((c) => {
if (c.type !== 'caption') {
return c;
}

const currentCaption = get(c, 'children[0].text');

const currentCaption = get(c, 'children[0].text');
return {
...c,
children: [
{
...c.children[0],
text: `${captionPrefix}${currentCaption}`
}
]
};
});

return {
...c,
children: [
{
...c.children[0],
text: `${captionPrefix}${currentCaption}`
}
]
};
})
// Table should be reversed to make the caption appear first
if (child.type === TABLE_BLOCK) {
children.reverse();
}

return {
...child,
children
};
}

Expand Down
Loading