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

bids spec pdf version #430

Closed
wants to merge 9 commits into from
Closed

bids spec pdf version #430

wants to merge 9 commits into from

Conversation

Arshitha
Copy link
Contributor

This is a PR almost identical to PR #400 updated-pdf-version-specs except that this has much cleaner commit history and was created to address the issue of unwanted commits in the above referenced PR.

To gain a better understanding of why certain decisions were made while fixing the issue of generating pdf version of the specs, discussions in the following issues would be useful references:

Bugs Fixed:

  • Stable Table of Contents page
  • Cover page
  • Non-tabular text overflow
  • Overlapping columns of tables (owing to small widths of the pipe tables in the markdown files)
    • Markdown files were edited (one-time edit) to increase the column widths of pipe tables
    • Does not affect the read the docs version of specs. However, if any tables were added to the specs in future, there needs to a standard that works for both pdf AND read the docs version of the specs.
  • Automating header to include the latest release version number and build date (pulled from mkdocs.yml)

Enhancements required (non-exhaustive list):

  • Internal links referencing either the same markdown file or other markdown files break during conversion from markdown to pdf. Currently, all of the internal links are removed and replaced by the accompanying text.
  • Superscripts are lost in conversion as well
  • Tried a couple different family of fonts to fix the missing character warnings for emojis used in the markdowns with no success. It would be ideal to fix this to match the Read The Docs version more closely
  • Entity table in Appendix IV has overlapping unreadable columns since it's markdown equivalent has more than 10 columns. Refer to issue for more discussion

updated pandon-script.sh adds a

-  a cover page. cover.tex file uses the bids logo

- a header with BIDS version number, however, this isn't automated. The header.tex file needs to be updated
for new version release of BIDS specs.

- font change is possible. However, the default LaTex font seemed better to me but can be changed with -V mainfont="DejaVu Serif" or any other
font.

- spacing after 'Quantitative T1rho brain imaging' and before URL on page 21 was modified in the corresponding .md file in the src directory.
merging changes from base repo
merging most recent upstream commits
updating fork with base repo
@Arshitha
Copy link
Contributor Author

@sappelhoff Except the last two commits the rest are perhaps from the master branch of my forked repo. would this work?

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