Skip to content

Commit

Permalink
Set up file structure for Antora (English language)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmarpons committed Jun 21, 2018
1 parent a96144c commit b94c326
Show file tree
Hide file tree
Showing 15 changed files with 100 additions and 18 deletions.
4 changes: 2 additions & 2 deletions ca/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ include::../locale/attributes.adoc[]

// end::metadata[]

// tag::metadata-table[]

= Metadades

// tag::metadata-table[]

[cols="20,80"]
|===
| Títol | {_title}
Expand Down
27 changes: 27 additions & 0 deletions en/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# MANDATORY. Identifier of the document in URLs. Use '-' as word separator.
# It can include letters, numbers and periods ( . ), but no other symbols.
# Example: "my-awesome-doc" (quotes not needed)
name:

# MANDATORY. Title of the document as we want it to appear in docs.decidim.org
# menus and navigation links. It's probably the same as README.adoc's
# :_title: attribute.
# Example: "My Awesome Document" (quotes not needed)
title:

# MANDATORY. "en", "es" or "ca". If more than one revision of the document is
# going to be shown, then append the revision as it appears in README.adoc's
# :revnumber: attribute, e.g., "en/0.1" (quotes not needed).
version: en

# MANDATORY. First page to show when we visit this document in docs.decidim.org.
# It must be "ROOT:" followed by a file present in modules/ROOT/pages/. See
# https://docs.antora.org/antora/1.0/page/page-id/ to understand how Antora's
# Page Ids work.
start_page: ROOT:introduction.adoc

# MANDATORY. A list of Antora navigation files. You probably don't need to
# change this field. See https://docs.antora.org/antora/1.0/navigation/
# if you want to learn more about it.
nav:
- modules/ROOT/nav.adoc
4 changes: 4 additions & 0 deletions en/modules/ROOT/_attributes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:attachmentsdir: {moduledir}/assets/attachments
:examplesdir: {moduledir}/examples
:imagesdir: {moduledir}/assets/images
:partialsdir: {moduledir}/pages/_partials
File renamed without changes.
Empty file.
Empty file.
13 changes: 13 additions & 0 deletions en/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Add to the following list cross references to all the contents you want
// listed in the navigation menu for this document.
.Contents
* xref:introduction.adoc[Introduction]
* Second section
** Subsection A
** Subsection B
* Third section
.Resources
* xref:metadata.adoc[Metadata]
* xref:contributing.adoc[Authorship criteria and how to contribute to this document]
* xref:single-page.adoc[Single page view]
2 changes: 2 additions & 0 deletions en/modules/ROOT/pages/_attributes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
:moduledir: ..
include::{moduledir}/_attributes.adoc[]
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
= Authorship criteria and how to contribute to this document

// tag::contents[]

This document is open to participation.
If you are familiar with Git and Pull Requests you can clone
ifdef::_public_repo_url[{_public_repo_url}[the public repository]]
Expand Down Expand Up @@ -37,3 +39,5 @@ Such work is generally commissioned (requested from a person regarded as compete
In such cases, the depth and quality of the proofreading process may qualify a person to be considered as a proofreader.

This division and specification of authorship levels has been directly copied from the criteria established under http://floksociety.org/[the FLOK Society - Buen conocer] (see http://book.floksociety.org/ec/[Barandiaran et al. 2015], pp. 38-39).

// end::contents[]
12 changes: 3 additions & 9 deletions en/README.adoc → en/modules/ROOT/pages/_partials/README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// tag::metadata[]
:lang: en

// MANDATORY. URL pointing to a Git repository with the source code of the
// document. Something like 'https://github.com/decidim/docs-features'.
:_public_repo_url:
Expand Down Expand Up @@ -73,20 +75,16 @@

// end::metadata[]

// tag::page-title[]

= {doctitle}

{_summary}

This document is part of the https://docs.decidim.org[Decidim documentation].

// end::page-title[]
== Metadata

// tag::metadata-table[]

== Metadata

[cols="20,80"]
|===
| Title | {_title}
Expand Down Expand Up @@ -119,10 +117,6 @@ You are permitted to copy, distribute and/or modify this document under the term

// end::metadata-table[]

// tag::contributing[]

== How to contribute

See link:./CONTRIBUTING.adoc[Contributing].

// end::contributing[]
8 changes: 8 additions & 0 deletions en/modules/ROOT/pages/contributing.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
= Authorship criteria and how to contribute to this document
ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]

include::{partialsdir}/README.adoc[tag=metadata]

include::{partialsdir}/CONTRIBUTING.adoc[tag=contents]
8 changes: 8 additions & 0 deletions en/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
= Introduction
ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]

include::{partialsdir}/README.adoc[tag=metadata]

// Start writing here
8 changes: 8 additions & 0 deletions en/modules/ROOT/pages/metadata.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
= Metadata
ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]

include::{partialsdir}/README.adoc[tag=metadata]

include::{partialsdir}/README.adoc[tag=metadata-table]
24 changes: 19 additions & 5 deletions en/index.adoc → en/modules/ROOT/pages/single-page.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
include::README.adoc[tag=metadata]
ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]

// (1/4) CHANGE TOC POSITION AND LEVELS, IF NEEDED.
include::{partialsdir}/README.adoc[tag=metadata]

// (1/4) CHANGE TOC POSITION AND LEVELS, IF NEEDED. ALSO :sectnums:
ifndef::env-site,env-github[]
:toc: left
endif::[]
:toclevels: 2

:sectnums!:
include::README.adoc[tag=metadata-table]

== Metadata

include::{partialsdir}/README.adoc[tag=metadata-table]

<<<

include::README.adoc[tag=contributing]
== Authorship criteria and how to contribute to this document

include::{partialsdir}/CONTRIBUTING.adoc[tag=contents]

<<<

:leveloffset: +1
Expand All @@ -20,6 +32,8 @@ include::README.adoc[tag=contributing]
// (3/4) ADD BELOW THE LIST OF REGULAR CHAPTERS OR SECTIONS. IMPORTANT: PUT A
// BLANK LINE BETWEEN INCLUDES.

include::introduction.adoc[]


[appendix]
// (4/4) ADD BELOW THE LIST OF APPENDIXES. IMPORTANT: PUT A BLANK LINE BETWEEN
Expand Down
4 changes: 2 additions & 2 deletions es/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ include::../locale/attributes.adoc[]

// end::metadata[]

// tag::metadata-table[]

= Metadatos

// tag::metadata-table[]

[cols="20,80"]
|===
| Título | {_title}
Expand Down

0 comments on commit b94c326

Please sign in to comment.