Comments (4)
@NateWr, I love the new split navigation menu for the table of contents in the Docs Hub, but it would be even better if the current chapter or section that the user is in could be highlighted. This would make it a lot easier for the user to remember which chapter or section they're in and to navigate to another chapter or section. Would it be hard to implement this?
from pkp-docs.
Mmm, yes a bit more tricky because we are storing the table of contents as markdown instead of structured data (like the yaml files where cards are defined).
This has been the source of some of the other challenges we have (ie - next/previous pages or links to this page in another language). We inherited this structure from the original conversion over from gitbooks. To resolve this and related issues, we'd need to convert every SUMMARY.md
file:
* [Preface](.)
* [Introduction](./introduction.md)
* [Background](./introduction.md#background)
* [OJS Features](./introduction.md#ojs-features)
...
To something like:
toc:
- name: "Preface"
path: "."
- name: Introduction
path: "./introduction.md"
sections:
- name: "Background"
path: "./introduction.md#background"
- name: "OJS Features"
path: "./introduction.md#ojs-features"
I might be able to write an automated conversion tool, but we may need the docs team to do the conversion manually. We may also need to move these files out of their respective categories and into the _data
directory, which might be a little more complicated for the docs team to manage.
If it sounds like grunt work the docs team would be willing to do, I can try to set aside a little bit of time in the next few weeks for a quick experiment to see if we can implement some of these features fairly easily...
from pkp-docs.
One concern I have with moving things into the _data
directory is how it would impact translations. Currently the translators are translating the contents of the guide directory in GitLocalize, but moving it out of that directory and into _data
would add some complexity to this since the file would no longer appear in GitLocalize. We would then have to do a more manual request to get the translation of the TOC, or create it ourselves based on their translation work.
from pkp-docs.
Yeah that would be a significant downside. I did a quick search but didn't find anything suggesting we could access data files outside of the _data
directory.
from pkp-docs.
Related Issues (20)
- Release Notebook 3.4: UserGroupDAO replaced with Repository HOT 1
- Release Notebook 3.4: Add note on sending email HOT 1
- Update documentation on HookRegistry HOT 1
- Provide WYSIWYG editing form for “Edit this Page/Make a Suggestion”
- Add a link to "Translate this page" to every Docs Hub page
- Enhance "Make a suggestion" form so the user can reference the page they clicked through from
- Clarify "Google Scholar will not index multilingual articles in OJS"
- Add docs on events/listeners HOT 1
- Publication titles now returned as HTML in API HOT 1
- Add required composer to OMP getting started
- Review pkp-docs README local preview instructions HOT 2
- Restore a "quick-start" section to the admin guide HOT 2
- Explicit memory limit should be specified on the upgrade command line HOT 1
- Add documentation for "developing registration agency plugin in 3.4+" HOT 1
- Release Notebook 3.4: Add note on changes to date/time config HOT 3
- Release Notebook 3.4: Add functions removed from submission and galley objects HOT 2
- Release Notebook 3.4: Add localization updates HOT 3
- Release Notebook 3.4: User::getContactSignature() removed HOT 1
- Release Notebook 3.4: Auto removal of unvalidated expired users HOT 1
- Combine descriptive API documentation in generated doc files HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pkp-docs.