{"id":13791545,"url":"https://github.com/juliantao/quarto-asce","last_synced_at":"2025-04-13T05:13:08.890Z","repository":{"id":128494577,"uuid":"541913694","full_name":"juliantao/quarto-asce","owner":"juliantao","description":"Quarto Extension for ASCE publications","archived":false,"fork":false,"pushed_at":"2025-04-09T18:40:27.000Z","size":2626,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T05:13:04.002Z","etag":null,"topics":["asce","journal","latex","pdf","proceedings","quarto","quarto-extension","quarto-template"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/juliantao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-27T05:14:17.000Z","updated_at":"2025-04-09T18:40:31.000Z","dependencies_parsed_at":"2024-08-21T02:33:05.797Z","dependency_job_id":"dcde656d-87a8-49ca-ab17-aa7b3d2d57be","html_url":"https://github.com/juliantao/quarto-asce","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":"quarto-journals/article-format-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliantao%2Fquarto-asce","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliantao%2Fquarto-asce/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliantao%2Fquarto-asce/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliantao%2Fquarto-asce/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/juliantao","download_url":"https://codeload.github.com/juliantao/quarto-asce/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248665746,"owners_count":21142123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asce","journal","latex","pdf","proceedings","quarto","quarto-extension","quarto-template"],"created_at":"2024-08-03T22:01:01.618Z","updated_at":"2025-04-13T05:13:08.883Z","avatar_url":"https://github.com/juliantao.png","language":"TeX","funding_links":[],"categories":["Templates"],"sub_categories":["Journals"],"readme":"\u003e **Warning**\n\n\u003e Starting from version 1.0.0, a cleaner tex can be generated for direct submission to journals or conferences. This is achieved by directly constructing the template with only partials that are absolutely necessary. \n\u003e There are still some rough edges in this extension, especially on the handling of the `authors and affiliations` in the title block. \n\u003e Use with caution.\n\u003e Contribution welcomed!\n\n# ASCE Quarto Template\n\nThis is a Quarto template that assists you in creating a manuscript for American Society of Civil Engineers journals and conference proceedings. You can learn more about the format requirements on the [ASCE website](https://ascelibrary.org/page/authorservicesjournals) and the [Overleaf template](https://www.overleaf.com/latex/templates/template-for-preparing-your-submission-to-the-american-society-of-civil-engineers-asce/pbwcqsvndpty), which this Quarto template was based off.\n\nThe \"`ascelike-new.cls`\" class and \"`ascelike-new.bst`\" citation style is from [Overleaf](https://www.overleaf.com) developed by Matthew R. Kuhn.\nStarting from Version 1.0.0, we are no longer using Pandoc's `citproc`, but rely on the original `ascelike-new.bst` citation file using `natbib` as the citation method.\n\n## Creating a New Article\n\nYou can use this as a template to create an article for an AFT journal. To do this, use the following command:\n\n```bash\nquarto use template juliantao/quarto-asce\n```\n\nThis will install the extension and create an example qmd file and bibiography that you can use as a starting place for your article.\n\n## Installation For Existing Document\n\nYou may also use this format with an existing Quarto project or document. From the quarto project or document directory, run the following command to install this format:\n\n```bash\nquarto install extension juliantao/quarto-asce\n```\n\n## Usage\n\nTo use the format, you can use the format names `asce-pdf`. For example:\n\n```bash\nquarto render article.qmd --to asce-pdf\n```\n\nor in your document yaml\n\n```yaml\nformat:\n  pdf: default\n  asce-pdf:\n    keep-tex: true    \n```\n\nYou can view a preview of the rendered template at \u003chttps://github.com/juliantao/quarto-asce/blob/main/style-guide/asce-template.pdf\u003e.\n\n## Format Options\n\nThe title block, document classes, and other document options can be set in the `yaml` header.\n\nFor example, to generate the example PDF file, the following `yaml` header is used\n\n```{.yaml} \ntitle: | \n  Template for Preparing Your Submission to the \n  American Society Of Civil Engineers (ASCE) \n\nauthor:\n  - name: Author One, S.M. ASCE\n    affiliations: Graduate Research Associate, First affiliation address\n    email: author.one@email.com\n  - name: Author Two, M. ASCE\n    affiliations: Assistant Professor, Second affiliation address\n    email: author.two@email.com\n  - name: Author three, A.M. ASCE\n    affiliations: Associate Professor, Third affiliation address\n    email: author.three@email.com\n    corresponding: true\ncode-highlighter: true # This line can be removed for most cases to keep the tex file cleaner.\nabstract: |\n  The abstract should be a single paragraph (150-175 words long) written\n  in plain language and include a summary of the key conclusions of the\n  manuscript. It should clearly state the purpose of the work, the scope\n  of the effort, the procedures used to execute the work, and major\n  findings. The abstract is the second most important online search\n  discovery element, after the title. Authors should review the abstract\n  to ensure that it accurately reflects the revised paper and should\n  strive to include any applicable keywords that would likely be used\n  during an online search. Mathematics and references are not permitted\n  in the abstract and will be removed by the copyeditors.\nkeywords: template, quarto, asce\nbibliography: references.bib\nformat: \n  asce-pdf:\n    keep-tex: true\n    publication-type: NewProceedings\n    footer-lastname: Author1\n    classoption: [InsideFigs, LineNumbers]\n```\n\n## Notes on Tables\n\n-   It is recommended to use raw `\\LaTeX` code blocks to construct tables for PDF output.  \n    Label your table using the format `\\label{tbl-xx}` and cite it in the text with `Table~\\ref{tbl-xx}`.  \n    For HTML output, use a Markdown table wrapped in a conditional div:  \n    `.content-visible when-format=\"html\"`.\n\n-   If you use a Markdown table for PDF rendering, the `table-replacement.lua` filter will convert it to a `tabular` environment (not `longtable`).  \n    The `booktabs` package is still applied for improved formatting.  \n    For example, Table~\\ref{tbl-assembly} is rendered directly from a Markdown table.\n\n-   If a `longtable` environment is required (e.g., for multi-page tables), you can use raw LaTeX within a `{=latex}` code block.  \n    Table \\ref{tbl-longtable} demonstrates a table created this way. The downside is that for `Journal` option, the table will be placed in instead of after the main text.\n    However, the caption will still be included in the `List of Tables`.  This will mess up the Table numbers and your first `longtable` will always be the Table 1 since it appears in the text.\n    So a suggestions is, avoid using `longtable` if possible.\n\n## `code-highlighter`\n\nWhen set to true, Quarto’s default code highlighting style is included, which adds a lengthy block to the LaTeX preamble. In most cases, this is unnecessary.\n\nIn this example, it is enabled to demonstrate the highlighted YAML block above.\nTo produce a cleaner .tex file for submission, simply remove this line from your YAML header.\n\n## Authors and affiliations\n\nFor now, I prefer to use a simplified way to define the authors and affiliations: just use `name`, `affiliations`, `email` and `corresponding` fields. See above `yaml` header. \nI may change this in the future.\n\nFor more detailed setups, see [quarto document](https://quarto.org/docs/journals/authors.html).\n\n## Format options\n\nThe document class `ascelike-new.cls` provides several options given\nbelow. \n\n### Publication types\n\nThe `Proceedings|Journal|NewProceedings` option is the most\nimportant; the other options are largely incidental.\n\nIn a quarto document, use `publication-type` to specify the overall format.\n\n1.  Options `Journal|Proceedings|NewProceedings` specify the overall\n    format of the output manuscript.\n\n    `Journal` produces double-spaced manuscripts for ASCE journals. As\n    default settings, it places tables and figures at the end of the\n    manuscript and produces lists of tables and figures. It places line\n    numbers within the left margin.\n\n    `Proceedings` produces older-style camera-ready single-spaced\n    manuscripts for ASCE conference proceedings. The newer ASCE style is\n    enacted with the `NewProceedings` option.\n\n    `NewProceedings` produces newer-style single-spaced manuscripts for\n    ASCE conference proceedings, as shown on the ASCE website (*ca.*\n    2013). As default settings, `NewProceedings` places figures and\n    tables within the text. It does not place line numbers within the\n    left margin.\n\n    If desired, the bottom right corner can be \"tagged\" with the\n    author's name (this can be done by inserting the command\n    `\\NameTag{\u003c`*your name*`\u003e}` within the preamble of your document).\n    All of the default settings can be altered with the options that are\n    described below.\n\n### Fine-tuning options\n\nUse `classoption` to specify the following options.\n\n2.  Options `BackFigs|InsideFigs` can be used to override the default\n    placement of tables and figures in the `Journal`, `Proceedings`, and\n    `NewProceedings` formats.\n\n3.  Options `SingleSpace|DoubleSpace` can be used to override the\n    default text spacing in the `Journal`, `Proceedings`, and\n    `NewProceedings` formats.\n\n4.  Options `10pt|11pt|12pt` can be used to override the default text\n    size (12pt).\n\n5.  The option `NoLists` suppresses inclusion of lists of tables and\n    figures that would normally be included in the `Journal` format.\n\n6.  The option `NoPageNumbers` suppresses the printing of page numbers.\n\n7.  The option `SectionNumbers` produces an automatic numbering of\n    sections. Without the `SectionNumbers` option, sections will *not*\n    be numbered, as this seems to be the usual formatting in ASCE\n    journals (note that the Appendixes will, however, be automatically\n    \"numbered\" with Roman numerals). With the `SectionNumbers` option,\n    sections and subsections are numbered with Arabic numerals (e.g. 2,\n    2.1, etc.), but subsubsection headings will not be numbered.\n\n8.  The options `NoLineNumbers|LineNumbers` can be used to override the\n    default use (or absence) of line numbers in the `Journal`,\n    `Proceedings`, and `NewProceedings` formats.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuliantao%2Fquarto-asce","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuliantao%2Fquarto-asce","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuliantao%2Fquarto-asce/lists"}